diff options
| author | Virgile Andreani <virgile.andreani@anbuco.fr> | 2014-01-26 13:39:39 +0100 |
|---|---|---|
| committer | Virgile Andreani <virgile.andreani@anbuco.fr> | 2014-01-26 13:39:39 +0100 |
| commit | 4004493f8af4ef94927f23154a86a4c936a0eec8 (patch) | |
| tree | 118e9d9b4bb1386b63bec9a4fcd67a8484bf585d /doc | |
| parent | 838b5a4cc072057f31453cdd1b50345f92e1a772 (diff) | |
| download | rust-4004493f8af4ef94927f23154a86a4c936a0eec8.tar.gz rust-4004493f8af4ef94927f23154a86a4c936a0eec8.zip | |
Unhide lines in rustdoc's doc -- Closes #11645
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rustdoc.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/rustdoc.md b/doc/rustdoc.md index ea87077b119..72282030fb3 100644 --- a/doc/rustdoc.md +++ b/doc/rustdoc.md @@ -139,9 +139,14 @@ that one can still write things like `#[deriving(Eq)]`). ~~~ ```rust -# // showing 'fib' in this documentation would just be tedious and detracts from -# // what's actualy being documented. -# fn fib(n: int) { n + 2 } +# /!\ The three following lines are comments, which are usually stripped off by +# the doc-generating tool. In order to display them anyway in this particular +# case, the character following the leading '#' is not a usual space like in +# these first five lines but a non breakable one. +# +# // showing 'fib' in this documentation would just be tedious and detracts from +# // what's actualy being documented. +# fn fib(n: int) { n + 2 } do spawn { fib(200); } ``` |
