Skip to content

Do not strip leading whitespace when parsing doc comments. - #7174

Closed
SiegeLord wants to merge 1 commit into
rust-lang:masterfrom
SiegeLord:remove_trim
Closed

Do not strip leading whitespace when parsing doc comments.#7174
SiegeLord wants to merge 1 commit into
rust-lang:masterfrom
SiegeLord:remove_trim

Conversation

@SiegeLord

Copy link
Copy Markdown
Contributor

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.

The bug can be seen, e.g., here: http://static.rust-lang.org/doc/std/iterator.html#example-12

I also altered how the block comments are treated, for consistency. There isn't much testing done on the documentation output (I added a few tests of my own for the modified function), so I don't know if anything relied on the previous behavior. I checked a number of documentation files and observed either no change in output or changes that consistent of the above bug being fixed.

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.
bors added a commit that referenced this pull request Jun 17, 2013
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.
The bug can be seen, e.g., here: http://static.rust-lang.org/doc/std/iterator.html#example-12
I also altered how the block comments are treated, for consistency. There isn't much testing done on the documentation output (I added a few tests of my own for the modified function), so I don't know if anything relied on the previous behavior. I checked a number of documentation files and observed either no change in output or changes that consistent of the above bug being fixed.
@borsbors closed this Jun 17, 2013
flip1995 pushed a commit to flip1995/rust that referenced this pull request May 6, 2021
Fix eval_order_dependence async false positive
changelog: Fix [`eval_order_dependence`] false positive in async code
Fixesrust-lang#6925
U007D pushed a commit to U007D/rust-mos that referenced this pull request Aug 21, 2026
7174: Normalize line endings when formatting r=matklad a=Jesse-Bakker
Fixesrust-lang#7166
Co-authored-by: Jesse Bakker <github@jessebakker.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@SiegeLord@brson@pnkfelix@bors