Skip to content
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

Merged
merged 1 commit into from
Jun 4, 2015

Conversation

pnkfelix
Copy link
Member

@pnkfelix pnkfelix commented Jun 3, 2015

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 #25699.

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.
@rust-highfive
Copy link
Collaborator

r? @pcwalton

(rust_highfive has picked a reviewer for you, use r? to override)

@Manishearth
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Jun 3, 2015

📌 Commit 01ddbe9 has been approved by Manishearth

/// (3.) either:
///
/// (A.) the Drop impl for `D` instantiates `D` at 'a directly,
/// * (1.) `D` has a lifetime- or type-parametric Drop implementation, and
Copy link
Member

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

Copy link
Member Author

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahhh interesting.

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.
bors added a commit that referenced this pull request Jun 4, 2015
@bors bors merged commit 01ddbe9 into rust-lang:master Jun 4, 2015
Sign up for free to 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.

6 participants