Skip to content

Commit

Permalink
Updated parenthetical
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-i-m committed Mar 15, 2018
1 parent 7c2af89 commit 81071c6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/rustdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
the Markdown parser. (In my experience it's less necessary now that we have a
Commonmark-compliant parser, since it doesn't have a problem with headers
that have a space before the `##` that marks the heading.)
the Markdown parser. (In the past, the markdown parser used was not Commonmark-
compliant, which caused annoyances with extra whitespace but this seems to be
less of an issue today.)
- `strip-priv-imports` strips all private import statements (`use`, `extern
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
Expand Down

0 comments on commit 81071c6

Please sign in to comment.