Prefer line comments // over block comments /* */ #2738
Merged
Conversation
This file contains 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
JurajSadel
commented
Dec 11, 2024
bugadani
approved these changes
Dec 12, 2024
There was a problem hiding this comment.
I'm somewhat conflicted here, I think we shouldn't specify style choices in our documentation, but we should consider rustfmt to only accept the style we want. The normalize_comments option exists, although unfortunately it's unstable. See rust-lang/rustfmt#3350
But we can move forward as is, the change is innocent enough.
MabezDev
approved these changes
Dec 12, 2024
|
Just had a thought, we could probably use nightly rustfmt this to normalize esp-wifi comments, even if we don't run it in CI. I think we have quite of these from generated code and/or copying C snippets. |
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.
Nothing too fancy, when I read through SPI driver I noticed we used /* */ in some places.