Skip to content

Fix RMAT docs#3071

Merged
rapids-bot[bot] merged 5 commits into
NVIDIA:mainfrom
divyegala:rmat-docs-fix
Jul 6, 2026
Merged

Fix RMAT docs#3071
rapids-bot[bot] merged 5 commits into
NVIDIA:mainfrom
divyegala:rmat-docs-fix

Conversation

@divyegala

Copy link
Copy Markdown
Contributor

No description provided.

@divyegala divyegala self-assigned this Jul 2, 2026
@divyegala divyegala requested a review from a team as a code owner July 2, 2026 20:08
@divyegala divyegala added doc Documentation non-breaking Non-breaking change labels Jul 2, 2026
@divyegala

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 16ad3f8c-a684-4f67-b453-b197fde2d65b

📥 Commits

Reviewing files that changed from the base of the PR and between 1d77863 and 371f32c.

📒 Files selected for processing (2)
  • cpp/tests/random/rmat_rectangular_generator.cu
  • cpp/tests/sparse/solver/lanczos.cu

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Improved Doxygen/API comment wording and parameter descriptions for the rmat rectangular generator.
    • Refined SPDX header formatting across updated headers and tests.
  • Bug Fixes
    • Corrected the output sizing rule for triple-vector generation to enforce matching first-dimension extents.
  • Tests
    • Updated rmat-related test allocations to construct views/arrays with the intended edge extents.
  • Style
    • Adjusted clang-format handling to preserve SPDX-related pragma comment lines.

Walkthrough

This PR updates SPDX-related formatting and comments in the rmat rectangular generator headers, changes one runtime output-size check, and aligns two tests with the revised edge-count sizing.

Changes

Header, docs, and extent alignment updates

Layer / File(s) Summary
Clang-format SPDX pragma support
cpp/.clang-format
Broadens CommentPragmas regex to recognize SPDX pragma markers alongside IWYU pragmas.
Detail header SPDX and comment fixes
cpp/include/raft/random/detail/rmat_rectangular_generator.cuh
Updates the SPDX header text and corrects Doxygen comment punctuation and backtick formatting in the detail generator header.
Output shape validation and docs
cpp/include/raft/random/detail/rmat_rectangular_generator_types.cuh
Updates the documented output extent relationship and the matching RAFT_EXPECTS check in the output triple constructor, with SPDX header text adjusted.
Public API doc fixes
cpp/include/raft/random/rmat_rectangular_generator.cuh
Reformats the SPDX header and corrects Doxygen precondition and parameter-description text across the public generator overload comments.
Test extent updates
cpp/tests/random/rmat_rectangular_generator.cu, cpp/tests/sparse/solver/lanczos.cu
Adjusts the rmat rectangular generator test mdspan extent and the Lanczos test allocation to use the updated edge-count sizing, with SPDX header text updated in both files.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No description was provided, so the PR intent can't be validated from the description alone. Add a short description summarizing the RMAT documentation, comment, and test-assertion updates.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately reflects the PR's main focus on RMAT documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@cpp/include/raft/random/rmat_rectangular_generator.cuh`:
- Around line 64-65: The `@pre` contract in the rmat_rectangular_generator docs is
incorrect in both overloads: `out.extent(0)` should match `out_src.extent(0)`,
not `2 * out_src.extent(0)`. Update the documentation near the affected
overloads in `rmat_rectangular_generator.cuh` so the precondition reflects the
actual `n_edges x 2` mdspan shape and stays consistent with `out_src` and
`out_dst`.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 55d24fc3-95bb-4f43-ac89-cfff3c61daa2

📥 Commits

Reviewing files that changed from the base of the PR and between 2141422 and 7cb31b4.

📒 Files selected for processing (3)
  • cpp/.clang-format
  • cpp/include/raft/random/detail/rmat_rectangular_generator.cuh
  • cpp/include/raft/random/rmat_rectangular_generator.cuh

Comment thread cpp/include/raft/random/rmat_rectangular_generator.cuh Outdated
@divyegala divyegala added the DO NOT MERGE Hold off on merging; see PR for details label Jul 2, 2026
Comment thread cpp/.clang-format Outdated
BreakStringLiterals: true
ColumnLimit: 100
CommentPragmas: '^ IWYU pragma:'
CommentPragmas: '(IWYU pragma:|SPDX-)'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same change as this one #3067

@divyegala divyegala removed the DO NOT MERGE Hold off on merging; see PR for details label Jul 6, 2026
@divyegala

Copy link
Copy Markdown
Contributor Author

/merge

@rapids-bot rapids-bot Bot merged commit 7353194 into NVIDIA:main Jul 6, 2026
80 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants