We have now the CI ensure all doc strings remain formatted #16916
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
sql
alamb
reviewed
Jul 29, 2025
There was a problem hiding this comment.
Thank you @yazanmashal03 -- this is looking like a very nice improvement
Given the fact that this feature requires cargo nightly which we don't typically use in CI here is what I suggest:
- Remove the changes to CI and
rustfmt.tomlfrom this PR - Run the tool manually to format the examples (keep that in this PR)
- File a new ticket/PR with just the changes to
rustfmt.tomlwhich we can merge once theformat_code_in_doc_commentsfeature is related in stable
| @@ -17,6 +17,7 @@ | |||
|
|
|||
| edition = "2021" | |||
| max_width = 90 | |||
| format_code_in_doc_comments = true # nightly-only feature | |||
There was a problem hiding this comment.
When I run cargo fmt now locally I see many warnings like this
(venv) andrewlamb@Andrews-MacBook-Pro-3:~/Software/datafusion$ cargo fmt
Warning: can't set `format_code_in_doc_comments = true`, unstable features are only available in nightly channel.
Warning: can't set `format_code_in_doc_comments = true`, unstable features are only available in nightly channel.
Warning: can't set `format_code_in_doc_comments = true`, unstable features are only available in nightly channel.
Warning: can't set `format_code_in_doc_comments = true`, unstable features are only available in nightly channel.
Warning: can't set `format_code_in_doc_comments = true`, unstable features are only available in nightly channel.
Warning: can't set `format_code_in_doc_comments = true`, unstable features are only available in nightly channel.
Warning: can't set `format_code_in_doc_comments = true`, unstable features are only available in nightly channel.
Which I think means we have to wait until this feature is actually released in stable Rust to add it to this file
| run: rustup toolchain install nightly | ||
|
|
||
| - name: Run rustfmt (nightly) | ||
| run: cargo +nightly fmt --all -- --config format_code_in_doc_comments=true |
There was a problem hiding this comment.
Thank you @yazanmashal03
I am not sure what this check is doing - it seems to just run the fmt rather than check its output, for example
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 change ensures the CI process has all docs strings remain formatted.
What changes are included in this PR?
The rustfmt.toml enables the "format_code_in_doc_comments" feature. I also added the ci file in the .github directory.
Are these changes tested?
Yes, running "cargo +nightly fmt --all -- --config format_code_in_doc_comments=true" can duplicate the effect of this solution.
Are there any user-facing changes?
No. And thank you for a first-issue. I hope it is good, and if there is anything I can add, let me know.