about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-06-30 15:37:44 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-06-30 15:37:44 -0400
commit96dd82ff9c30430bab47be59d753f7baaf25cf98 (patch)
tree0fbbf6d0b22ef431445dea9b5db0b2d7df0273c4
parent9d641316f134eed5b271c962b90b7ccc4964a8a6 (diff)
parente13077f7f089664a847f9fa1f081f0ff8f413726 (diff)
downloadrust-96dd82ff9c30430bab47be59d753f7baaf25cf98.tar.gz
rust-96dd82ff9c30430bab47be59d753f7baaf25cf98.zip
Rollup merge of #26506 - tshepang:doc-fix, r=steveklabnik
-rw-r--r--src/doc/trpl/documentation.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/doc/trpl/documentation.md b/src/doc/trpl/documentation.md
index 7102158383a..01b53a6c49d 100644
--- a/src/doc/trpl/documentation.md
+++ b/src/doc/trpl/documentation.md
@@ -33,8 +33,10 @@ pub fn new(value: T) -> Rc<T> {
 ```
 
 This code generates documentation that looks [like this][rc-new]. I've left the
-implementation out, with a regular comment in its place. That's the first thing
-to notice about this annotation: it uses `///`, instead of `//`. The triple slash
+implementation out, with a regular comment in its place.
+
+The first thing to notice about this annotation is that it uses
+`///` instead of `//`. The triple slash
 indicates a documentation comment.
 
 Documentation comments are written in Markdown.
@@ -375,7 +377,7 @@ $ rustdoc --test path/to/my/crate/root.rs
 $ cargo test
 ```
 
-That's right, `cargo test` tests embedded documentation too. However, 
+That's right, `cargo test` tests embedded documentation too. However,
 `cargo test` will not test binary crates, only library ones. This is
 due to the way `rustdoc` works: it links against the library to be tested,
 but with a binary, there’s nothing to link to.