Rewrap doc comments to always have a succinct first paragraph #1418
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
Clippy is unhappy about some of our doc comments, and I agree with it. They're supposed to have a succinct first paragraph that can be rendered as a summary (also helpful in our OpenAPI docs). This PR makes it so, at least for all the comments that were surpassing the threshold that makes clippy warn about an overly long first paragraph.
svix-gabriel
approved these changes
Sep 4, 2024
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.
Clippy is unhappy about some of our doc comments, and I agree with it. They're supposed to have a succinct first paragraph that can be rendered as a summary (also helpful in our OpenAPI docs). This PR makes it so, at least for all the comments that were surpassing the threshold that makes clippy warn about an overly long first paragraph.