From ff2ff2b2b88f5948e1326809e70fbdf4db167097 Mon Sep 17 00:00:00 2001
From: Lucas Morales <lucas@lucasem.com>
Date: Wed, 4 Jul 2018 08:56:31 -0400
Subject: [PATCH] rustdoc book on codeblock hash escaping

---
 src/doc/rustdoc/src/documentation-tests.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/doc/rustdoc/src/documentation-tests.md b/src/doc/rustdoc/src/documentation-tests.md
index 7639537fc553..e4af122d0cb9 100644
--- a/src/doc/rustdoc/src/documentation-tests.md
+++ b/src/doc/rustdoc/src/documentation-tests.md
@@ -170,6 +170,23 @@ By repeating all parts of the example, you can ensure that your example still
 compiles, while only showing the parts that are relevant to that part of your
 explanation.
 
+The `#`-hiding of lines can be prevented by using two consecutive hashes
+`##`. This only needs to be done with with the first `#` which would've
+otherwise caused hiding. If we have a string literal like the following,
+which has a line that starts with a `#`:
+
+```rust
+let s = "foo
+## bar # baz";
+```
+
+We can document it by escaping the initial `#`:
+
+```text
+/// let s = "foo
+/// ## bar # baz";
+```
+
 
 ## Using `?` in doc tests