Skip to content

docs: fix Vale heading case errors in gRPC async client docs - #1682

Merged
rapids-bot[bot] merged 1 commit into
mainfrom
fix/vale-heading-case
Aug 6, 2026
Merged

docs: fix Vale heading case errors in gRPC async client docs#1682
rapids-bot[bot] merged 1 commit into
mainfrom
fix/vale-heading-case

Conversation

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

Summary

Fixes three heading case errors flagged by the Vale prose linter (added in #1668) in docs that were merged in #1653 before Vale was introduced.

  • python-async-client-api.rst: See alsoSee Also
  • index.rst: When to choose which pathWhen to Choose Which Path
  • python-async-client.rst: Next stepsNext Steps

These errors are currently blocking check-style on every open PR.

Testing

Pre-commit passes on all three files.

Docs

Heading text only — no content change.

@ramakrishnap-nv
ramakrishnap-nv requested a review from a team as a code owner August 6, 2026 00:52
@ramakrishnap-nv
ramakrishnap-nv requested a review from Iroy30 August 6, 2026 00:52
@ramakrishnap-nv ramakrishnap-nv self-assigned this Aug 6, 2026
@ramakrishnap-nv ramakrishnap-nv added non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels Aug 6, 2026
@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator Author

/merge

@coderabbitai

coderabbitai Bot commented Aug 6, 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: 2ab2028a-57d7-42e1-8780-dfe5d268c459

📥 Commits

Reviewing files that changed from the base of the PR and between 9eefd80 and 5b737c3.

📒 Files selected for processing (3)
  • docs/cuopt/source/cuopt-grpc/index.rst
  • docs/cuopt/source/cuopt-grpc/python-async-client-api.rst
  • docs/cuopt/source/cuopt-grpc/python-async-client.rst

📝 Walkthrough

Walkthrough

Three gRPC documentation headings now use title-case capitalization.

Changes

gRPC documentation heading capitalization

Layer / File(s) Summary
Standardize section headings
docs/cuopt/source/cuopt-grpc/*.rst
Updated “When to Choose Which Path,” “See Also,” and “Next Steps” headings.
Estimated code review effort: 1 (Trivial) ~2 minutes

Possibly related PRs

  • NVIDIA/cuopt#1668: Applies the title-case convention to headings in the same documentation tree.

Suggested labels: doc

Suggested reviewers: iroy30, tmckayus

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the heading case fixes in the gRPC async client documentation.
Description check ✅ Passed The description directly explains the three heading case fixes, their purpose, testing, and documentation scope.
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
  • Commit unit tests in branch fix/vale-heading-case

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

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

CI Test Summary

✅ All 31 test job(s) passed.

@rapids-bot
rapids-bot Bot merged commit 07dddec into main Aug 6, 2026
93 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants