@@ -9,7 +9,7 @@ These commands will appropriately invoke `rustdoc` (and `rustc`) as required.
99### Doc comments
1010
1111Doc comments are very useful for big projects that require documentation. When
12- running Rustdoc , these are the comments that get compiled into
12+ running ` rustdoc ` , these are the comments that get compiled into
1313documentation. They are denoted by a ` /// ` , and support [ Markdown] .
1414
1515``` rust,editable,ignore
@@ -32,7 +32,7 @@ impl Person {
3232 ///
3333 /// ```
3434 /// // You can have rust code between fences inside the comments
35- /// // If you pass --test to Rustdoc , it will even test it for you!
35+ /// // If you pass --test to `rustdoc` , it will even test it for you!
3636 /// use doc::Person;
3737 /// let person = Person::new("name");
3838 /// ```
@@ -57,7 +57,7 @@ fn main() {
5757}
5858```
5959
60- To run the tests, first build the code as a library, then tell rustdoc where
60+ To run the tests, first build the code as a library, then tell ` rustdoc ` where
6161to find the library so it can link it into each doctest program:
6262
6363``` shell
@@ -68,7 +68,7 @@ $ rustdoc --test --extern doc="libdoc.rlib" doc.rs
6868### See also:
6969
7070* [ The Rust Book: Making Useful Documentation Comments] [ book ]
71- * [ The Rustdoc Book] [ rustdoc-book ]
71+ * [ The rustdoc Book] [ rustdoc-book ]
7272* [ The Reference: Doc comments] [ ref-comments ]
7373* [ RFC 1574: API Documentation Conventions] [ api-conv ]
7474* [ RFC 1946: Relative links to other items from doc comments (intra-rustdoc links)] [ intra-links ]
0 commit comments