diff options
Diffstat (limited to 'doc/rustdoc.md')
| -rw-r--r-- | doc/rustdoc.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/rustdoc.md b/doc/rustdoc.md index 39fc03bca0d..16bcf8d6dd8 100644 --- a/doc/rustdoc.md +++ b/doc/rustdoc.md @@ -132,9 +132,10 @@ specifiers that can be used to dictate how a code block is tested: ~~~ Rustdoc also supplies some extra sugar for helping with some tedious -documentation examples. If a line is prefixed with a `#` character, then the -line will not show up in the HTML documentation, but it will be used when -testing the code block. +documentation examples. If a line is prefixed with `# `, then the line +will not show up in the HTML documentation, but it will be used when +testing the code block (NB. the space after the `#` is required, so +that one can still write things like `#[deriving(Eq)]`). ~~~ ```rust |