diff --git a/src/meta/doc.md b/src/meta/doc.md index 4aa2cbf0cc..866c976d8a 100644 --- a/src/meta/doc.md +++ b/src/meta/doc.md @@ -9,7 +9,7 @@ These commands will appropriately invoke `rustdoc` (and `rustc`) as required. ### Doc comments Doc comments are very useful for big projects that require documentation. When -running Rustdoc, these are the comments that get compiled into +running `rustdoc`, these are the comments that get compiled into documentation. They are denoted by a `///`, and support [Markdown]. ```rust,editable,ignore @@ -32,7 +32,7 @@ impl Person { /// /// ``` /// // You can have rust code between fences inside the comments - /// // If you pass --test to Rustdoc, it will even test it for you! + /// // If you pass --test to `rustdoc`, it will even test it for you! /// use doc::Person; /// let person = Person::new("name"); /// ``` @@ -57,7 +57,7 @@ fn main() { } ``` -To run the tests, first build the code as a library, then tell rustdoc where +To run the tests, first build the code as a library, then tell `rustdoc` where to find the library so it can link it into each doctest program: ```shell @@ -68,7 +68,7 @@ $ rustdoc --test --extern doc="libdoc.rlib" doc.rs ### See also: * [The Rust Book: Making Useful Documentation Comments][book] -* [The Rustdoc Book][rustdoc-book] +* [The rustdoc Book][rustdoc-book] * [The Reference: Doc comments][ref-comments] * [RFC 1574: API Documentation Conventions][api-conv] * [RFC 1946: Relative links to other items from doc comments (intra-rustdoc links)][intra-links]