-
Notifications
You must be signed in to change notification settings - Fork 13.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix the dropck doc formatting to avoid hitting four-space indent. #25987
Conversation
This was causing `rustdoc` to interpret the part starting with `(A.) ...` as a code block based on its four-space indentation, which then was treated by `rustdoc` as a *Rust* code snippet, and thus was attempting (and failing) to parse my english as Rust code. Thus causing the compiler-docs build to fail. Independently, we should probably change `rustdoc` to not interpret four-space indents as code that needs to be tested; it seems too perilous to me at least. (But the formatting here needed to be changed either way.) cc Issue rust-lang#25699.
r? @pcwalton (rust_highfive has picked a reviewer for you, use r? to override) |
@bors: r+ rollup |
📌 Commit 01ddbe9 has been approved by |
/// (3.) either: | ||
/// | ||
/// (A.) the Drop impl for `D` instantiates `D` at 'a directly, | ||
/// * (1.) `D` has a lifetime- or type-parametric Drop implementation, and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why use both * and a number? 1.
on its own should make a list
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to use the capital letters A and B explicitly for the sub-bullets (which as far as I know is not supported by markdown). So that motivated me to use asterisks for the sub-bullets; then I just used asterisks throughout for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahhh interesting.
…=Manishearth Fix the dropck doc formatting to avoid hitting four-space indent. This was causing `rustdoc` to interpret the part starting with `(A.) ...` as a code block based on its four-space indentation, which then was treated by `rustdoc` as a *Rust* code snippet, and thus was attempting (and failing) to parse my english as Rust code. Thus causing the compiler-docs build to fail. Independently, we should probably change `rustdoc` to not interpret four-space indents as code that needs to be tested; it seems too perilous to me at least. (But the formatting here needed to be changed either way.) cc Issue rust-lang#25699.
Fix the dropck doc formatting to avoid hitting four-space indent.
This was causing
rustdoc
to interpret the part starting with(A.) ...
as a code block based on its four-space indentation, which then was treated byrustdoc
as a Rust code snippet, and thus was attempting (and failing) to parse my english as Rust code. Thus causing the compiler-docs build to fail.Independently, we should probably change
rustdoc
to not interpret four-space indents as code that needs to be tested; it seems too perilous to me at least.(But the formatting here needed to be changed either way.)
cc Issue #25699.