From eb203d597f6bed9bb6a7103649a36f19a087a2ab Mon Sep 17 00:00:00 2001 From: projektir Date: Mon, 13 Mar 2017 18:37:21 -0400 Subject: [PATCH] Adjust wording #40301 --- src/doc/book/src/documentation.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/doc/book/src/documentation.md b/src/doc/book/src/documentation.md index 551c393be775..176a7e508c0a 100644 --- a/src/doc/book/src/documentation.md +++ b/src/doc/book/src/documentation.md @@ -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: