about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2014-01-31 15:11:32 -0800
committerbors <bors@rust-lang.org>2014-01-31 15:11:32 -0800
commit83f0f6ef6cb44d9fbba24372f223561a75a50c18 (patch)
treefb5a63bf6647bba86ec8758c365e476d45eaab75
parent5a618129b842f875dac5531ce7b8385fe4fcda6c (diff)
parent4004493f8af4ef94927f23154a86a4c936a0eec8 (diff)
downloadrust-83f0f6ef6cb44d9fbba24372f223561a75a50c18.tar.gz
rust-83f0f6ef6cb44d9fbba24372f223561a75a50c18.zip
auto merge of #11810 : Armavica/rust/issue-11645, r=alexcrichton
The doc-generating tool comments out the lines that match `/$# /` (note the space), which is not what is wanted here. And it lets live the lines matching `/$#[^ ]/`. But we still want to see a space. So I replaced the normal space by a non breakable one, which fools the parser into displaying the line.
-rw-r--r--doc/rustdoc.md11
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); }
 ```