Handle escape sequences in doc-comments #173
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
sadmac7000
requested changes
Oct 13, 2023
sadmac7000
approved these changes
Oct 19, 2023
|
Looks like clippy is unhappy now. It's a bit of an annoying lint, I'm going to see if we can disable it. |
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.
As noted in #159,
rustdoccomments may contain CommonMark escape sequences, butarghoutputs these literally in the generated help, forcing the user to choose between correct display inrustdocor inargh’s generated help. This PR unescapes these escape sequences so that the text displayed inargh’s generated help matches that ofrustdoc. In addition, braces are escaped as theFromArgsmacro uses the resultant string as a format string.Fixes #159
Fixes #123