mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated parenthetical

This commit is contained in:
Who? Me?! 2018-03-15 12:46:59 -05:00
parent 474bdb566c
commit 80fa5ad68d
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/rustdoc.md
View File

@ -116,9 +116,9 @@ Here is current (as of this writing) list of passes:
markdown to like it. This is necessary because the convention for writing markdown to like it. This is necessary because the convention for writing
documentation is to provide a space between the `///` or `//!` marker and the documentation is to provide a space between the `///` or `//!` marker and the
text, and stripping that leading space will make the text easier to parse by text, and stripping that leading space will make the text easier to parse by
the Markdown parser. (In my experience it's less necessary now that we have a the Markdown parser. (In the past, the markdown parser used was not Commonmark-
Commonmark-compliant parser, since it doesn't have a problem with headers compliant, which caused annoyances with extra whitespace but this seems to be
that have a space before the `##` that marks the heading.) less of an issue today.)
- `strip-priv-imports` strips all private import statements (`use`, `extern - `strip-priv-imports` strips all private import statements (`use`, `extern
crate`) from a crate. This is necessary because rustdoc will handle *public* crate`) from a crate. This is necessary because rustdoc will handle *public*
imports by either inlining the item's documentation to the module or creating imports by either inlining the item's documentation to the module or creating