Reformat some function param docs for consistency #496
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
|
There were some minor changes. Please review the diff with "hide whitespace changes" to see them. |
|
I think the style convention of the function documentation params frequently adds a review roundtrip. Is it possible to automatically format them? Personally, I don't feel strong at all about this, and I'm OK with merging this PR anyway. |
I wish. To my knowledge, so such tool exists for C. One might be able to write their own clang-tidy checker. But I imagine that would involve quite a bit of work. |
jtraglia
force-pushed
the
consistent-param-docs
branch
from
2706a5a
to
9dbe211
Compare
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.
There were some functions using a single space vs a tab (of spaces) between the params.