Skip first doc comment line in path macro description expansion #881
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
Previously, the entire doc comment was used as the description, in addition to the summary using the first line of the doc comment, resulting in duplicated text. This commit changes the path macro doc comment extraction logic to split the first line from the rest of the body, and skip all lines until the first non-whitespace line. This results in the description no longer containing the summary. In degenerate cases, such as a doc comment consisting of new lines, this will invoke a full linear search over all lines in the doc comment. This should be relatively acceptable as most reasonable forms of doc comments shouldn't have more than a couple of newlines between the first line and subsequent body. For testing and verification, I've tested this in a private project using the `patch` override section in `Cargo.toml`, and tests needed to be changed to account for this change.
|
Looks like CI failure is related to not providing a feature flag? I don't believe that it's related to these changes. |
|
Yeah, seems like utoipa-gen requires features query+json to compile (#893) |
|
Yeah, probably some upstream crate feature changes that hasn't been propagated here has caused the error. |
juhaku
approved these changes
May 1, 2024
juhaku
added a commit
that referenced
this pull request
May 23, 2024
Priot to this PR the summary and description was blindly split by the first line of the doc comment of path operaiton. This caused long multi line summaries to be split from illogically bleeding part of the summary to the description. More context can be found from issue #942. This commit fixes this as from now one comments as follows will be correctly split by paragraph. Where first paragraph will resolve to summary and rest will become the description. ```rust /// This is test operation long multiline /// summary. That need to be correctly split. /// /// Additional info in long description /// /// With more info on separate lines /// containing text. /// /// Yeah ``` Follow up for #881 and #439 Fixes #942
juhaku
added a commit
that referenced
this pull request
May 23, 2024
Priot to this PR the summary and description was blindly split by the first line of the doc comment of path operaiton. This caused long multi line summaries to be split from illogically bleeding part of the summary to the description. More context can be found from issue #942. This commit fixes this as from now one comments as follows will be correctly split by paragraph. Where first paragraph will resolve to summary and rest will become the description. ```rust /// This is test operation long multiline /// summary. That need to be correctly split. /// /// Additional info in long description /// /// With more info on separate lines /// containing text. /// /// Yeah ``` Follow up for #881 and #439 Fixes #942
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.
Previously, the entire doc comment was used as the description in addition to the summary using the first line of the doc comment, resulting in duplicated text.
This commit changes the path macro doc comment extraction logic to split the first line from the rest of the body, and skip all lines until the first non-whitespace line. This results in the description no longer containing the summary.
In degenerate cases, such as a doc comment consisting of new lines, this will invoke a full linear search over all lines in the doc comment. This should be relatively acceptable as most reasonable forms of doc comments shouldn't have more than a couple of newlines between the first line and subsequent body.
For testing and verification, I've tested this in a private project using the
patchoverride section inCargo.toml, and tests needed to be changed to account for this change.This change was driven by my own preferences in documentation and in addition to this comment by @chrsteer: