about summary refs log tree commit diff
diff options
context:
space:
mode:
authorYoshito Komatsu <ykomatsu@akaumigame.org>2015-10-13 15:59:59 +0900
committerYoshito Komatsu <ykomatsu@akaumigame.org>2015-10-13 15:59:59 +0900
commit6ee31347b3e77114131ccd3c3ac9cc81588a3d68 (patch)
treef22164b0ca49ccb1961c77bc8a2cd31e1c49a115
parentec4362da562a4b591a7d120c6677e14ea713481a (diff)
downloadrust-6ee31347b3e77114131ccd3c3ac9cc81588a3d68.tar.gz
rust-6ee31347b3e77114131ccd3c3ac9cc81588a3d68.zip
Fix some typos
-rw-r--r--src/doc/trpl/documentation.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/doc/trpl/documentation.md b/src/doc/trpl/documentation.md
index 8cb58ecf2c7..158f34f687c 100644
--- a/src/doc/trpl/documentation.md
+++ b/src/doc/trpl/documentation.md
@@ -213,7 +213,7 @@ Let's discuss our sample example documentation:
 ```
 
 You'll notice that you don't need a `fn main()` or anything here. `rustdoc` will
-automatically add a main() wrapper around your code, and in the right place.
+automatically add a `main()` wrapper around your code, and in the right place.
 For example:
 
 ```rust
@@ -234,7 +234,7 @@ fn main() {
 }
 ```
 
-Here's the full algorithm rustdoc uses to postprocess examples:
+Here's the full algorithm rustdoc uses to preprocess examples:
 
 1. Any leading `#![foo]` attributes are left intact as crate attributes.
 2. Some common `allow` attributes are inserted, including
@@ -377,7 +377,7 @@ things, so they don’t show up in the output.
 
 ### Running documentation tests
 
-To run the tests, either
+To run the tests, either:
 
 ```bash
 $ rustdoc --test path/to/my/crate/root.rs
@@ -502,7 +502,8 @@ This `%` line needs to be the very first line of the file.
 
 ## `doc` attributes
 
-At a deeper level, documentation comments are sugar for documentation attributes:
+At a deeper level, documentation comments are syntactic sugar for documentation
+attributes:
 
 ```rust
 /// this
@@ -533,7 +534,7 @@ extern crate foo;
 pub use foo::bar;
 ```
 
-This will create documentation for bar both inside the documentation for the
+This will create documentation for `bar` both inside the documentation for the
 crate `foo`, as well as the documentation for your crate. It will use the same
 documentation in both places.