Skip to content

fix sentence in book/documentation.md #26506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2015
Merged

fix sentence in book/documentation.md #26506

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0adda45
book: fix sentence
tshepang Jun 22, 2015
e13077f
book: whitespace
tshepang Jun 22, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/doc/trpl/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -380,7 +382,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.
Expand Down