Fix RMAT docs

[divyegala]

No description provided.

[divyegala]

@coderabbitai review

[coderabbitai]

✅ 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]

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: 10a257b2-8b8f-4ad9-a8bc-4d37995e6210

📥 Commits

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

📒 Files selected for processing (2)

• cpp/include/raft/random/detail/rmat_rectangular_generator_types.cuh
• cpp/include/raft/random/rmat_rectangular_generator.cuh

✅ Files skipped from review due to trivial changes (1)

• cpp/include/raft/random/rmat_rectangular_generator.cuh

---

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Improved Doxygen/API comment clarity and punctuation for the rmat rectangular generator, including clearer parameter descriptions and precondition notes.
  • Updated SPDX header text formatting across affected headers.
• Bug Fixes
  • Corrected the documented and enforced output sizing rule for triple-vector generation to require matching first-dimension extents.
• Style
  • Updated formatting settings to better preserve SPDX-related pragma comment lines.

Walkthrough

This PR updates clang-format pragma matching for SPDX, refreshes SPDX header text, and fixes Doxygen comments across the rmat rectangular generator headers. One constructor check is also changed to match the updated documented output extent relationship.

Changes

Header and comment formatting cleanup

Layer / File(s)	Summary
Clang-format SPDX pragma support cpp/.clang-format	Broadens CommentPragmas regex to also match 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.

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

Related issues: None specified.

Related PRs: None specified.

Suggested labels: documentation, non-breaking

Suggested reviewers: None specified.

---

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No author description was provided, so there isn't enough detail to assess beyond the file summaries.	Add a brief description of the RMAT documentation and validation changes to clarify the PR’s intent.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly matches the PR’s RMAT documentation-focused changes.
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]

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

[aamijar]

Same change as this one #3067