rustdoc: should expect and interpret valid Markdown #40560
Labels
T-dev-tools
Relevant to the dev-tools subteam, which will review and decide on the PR/issue.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
steveklabnik
added
the
T-rustdoc
I don't know why I want to say @cmr may, but maybe? |
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Mar 27, 2017
…eklabnik rustdoc to accept `#` at the start of a markdown file rust-lang#40560 This may be a bit odd if `#` and `%` lines are mixed up, but that's not something I've found while doing my search and replace.
steveklabnik
added
the
T-dev-tools
|
I believe this is handled correctly today, closing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
rustdoc currently expects all Markdown files to start with the
%symbol, turning that line into an<h1>heading with the corresponding title. The%symbol is not part of Markdown, and this notation seems unnecessary.Instead, rustdoc should be able to read
#,##, and so on, as expected, turning them into<h1>,<h2>, respectively, and then correctly numbering the child headings. The first heading in the file can be used for the title and table of contents parenting. This should fix #39850.This will change rustdoc to additionally process the first
#heading (or any first heading?) the way it currently processes the%heading.I plan to work on this issue, but if anyone knows something about the history of
%that could be useful information.The text was updated successfully, but these errors were encountered: