]> git.lizzy.rs Git - rust.git/commitdiff
Unhide lines in rustdoc's doc -- Closes #11645
authorVirgile Andreani <virgile.andreani@anbuco.fr>
Sun, 26 Jan 2014 12:39:39 +0000 (13:39 +0100)
committerVirgile Andreani <virgile.andreani@anbuco.fr>
Sun, 26 Jan 2014 12:39:39 +0000 (13:39 +0100)
doc/rustdoc.md

index ea87077b1196be1be5b3ee83d0cebc17a11fce5d..72282030fb322ac6218404b2330450fe5c2fb45a 100644 (file)
@@ -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); }
 ```