Remove horizontal trimming from libsyntax::parse::comments::strip_doc_comment_decoration #7135
Conversation
This file contains hidden or 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
…_comment_decoration. This change prevents the indentation in code blocks inside the /// doc comments from being eaten. The indentation that is the same across the consecutive doc comments is removed by the uindent_pass in librustdoc.
flip1995
pushed a commit
to flip1995/rust
that referenced
this pull request
Oct 21, 2021
Cover `Result` for `question_mark` closes rust-lang#7135 changelog: [`question_mark`] now covers `Result`
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.
The bug this commit fixes manifests itself when you use the single line doc comments and indented code blocks, e.g. like so:
The resultant markdown code with the current code would look like this:
See, e.g., http://static.rust-lang.org/doc/std/iterator.html#example-12.
I also removed the horizontal trimming from the block doc comments too, to be consistent. The unindent_pass in librustdoc does a fine job taking care of leading white space.