ci: add check for doc comment formatting #18542
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
development-process
CuteChuanChuan
changed the title
CuteChuanChuan
force-pushed
the
raymond/16915-format-ci
branch
from
cadd5fb to
6f7c4fa
Compare
github-actions
bot
added
documentation
CuteChuanChuan
force-pushed
the
raymond/16915-format-ci
branch
from
305c31c to
2c1d0d6
Compare
github-actions
bot
removed
documentation
CuteChuanChuan
force-pushed
the
raymond/16915-format-ci
branch
from
2c1d0d6 to
0ed928f
Compare
CuteChuanChuan
changed the title
Contributor
Author
|
Hi @alamb , Following the discussion in PR #16916, I've prepared this PR to enable CI enforcement for doc comment formatting. As you mentioned, we need to use the same version of This PR contains two commits:
PTAL when you have chance. Thank you! |
alamb
reviewed
Dec 12, 2025
Contributor
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Thanks @CuteChuanChuan -- this looks really close. I think we just need to update where the command is run and this will be good to go from my perspective
Thank you for sticking with it
- Install nightly Rust toolchain with rustfmt component - Use cargo +nightly fmt to check both regular code and doc comments - Replace stable fmt check with nightly to avoid formatting conflicts
CuteChuanChuan
force-pushed
the
raymond/16915-format-ci
branch
from
481a43d to
bb6cfcf
Compare
github-actions
bot
added
proto
CuteChuanChuan
force-pushed
the
raymond/16915-format-ci
branch
from
bb6cfcf to
3d932e2
Compare
CuteChuanChuan
force-pushed
the
raymond/16915-format-ci
branch
from
3d932e2 to
dfdd028
Compare
Contributor
Author
|
Hi @alamb , Sorry for the late response. I've moved the nightly fmt command to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
This PR adds CI enforcement to ensure all code examples in documentation comments are properly formatted to maintain consistent code formatting, including examples in doc comments.
What changes are included in this PR?
This PR adds a new CI check in the
check-fmtjob that:cargo +nightly fmt --all -- --check --config format_code_in_doc_comments=trueNote:
format_code_in_doc_commentsis currently an unstable feature.Are these changes tested?
The command is tested locally with:
Are there any user-facing changes?
No user-facing changes.