Fix the dropck doc formatting to avoid hitting four-space indent. #25987
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
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.
why use both * and a number? 1. on its own should make a list
There was a problem hiding this comment.
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.
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Jun 4, 2015
…=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.
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.
Fix the dropck doc formatting to avoid hitting four-space indent.
This was causing
rustdocto interpret the part starting with(A.) ...as a code block based on its four-space indentation, which then was treated byrustdocas 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
rustdocto 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.