afaa406465
rustdoc codeblock hash escape
So that docstring text such as the following (in a code block) can be created ergonomically:
```rust
let s = "
foo
# bar
baz
";
```
Such code in a docstring hide the <code> # bar</code> line.
Previously, using two consecutive hashes <code> ## bar</code> would turn the line into _shown_ `# bar`, losing the leading whitespace. A line of code like <code> # bar</code> (such as in the example above) **could not be represented** in the docstring text.
This commit makes the two consecutive hashes not also trim the leading whitespace — the two hashes simply **escape** into a single hash and do not hide the line, leaving the rest of that line unaffected. The new docstring text to achieve the above code block is:
```rust
/// ```
/// let s = "
/// foo
/// ## bar
/// baz
/// ";
/// ```
```
|
||
|---|---|---|
| .. | ||
| clean | ||
| html | ||
| passes | ||
| Cargo.toml | ||
| core.rs | ||
| doctree.rs | ||
| externalfiles.rs | ||
| fold.rs | ||
| lib.rs | ||
| markdown.rs | ||
| plugins.rs | ||
| README.md | ||
| test.rs | ||
| theme.rs | ||
| visit_ast.rs | ||
| visit_lib.rs | ||
For more information about how librustdoc works, see the rustc guide.