user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adjust wording #40301

Browse source
This commit is contained in:
projektir 2017-03-13 18:37:21 -04:00
parent 064477391c
commit eb203d597f
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/doc/book/src/documentation.md
View file

@ -170,8 +170,6 @@ more than one section:
# fn foo() {}
```
Let's discuss the details of these code blocks.
#### Code block annotations
To write some Rust code in a comment, use the triple graves:
@ -183,6 +181,9 @@ To write some Rust code in a comment, use the triple graves:
# fn foo() {}
```
This will add code highlighting. If you are only showing plain text, put `text`
instead of `rust` after the triple graves (see below).
## Documentation as tests
Let's discuss our sample example documentation: