File tree Expand file tree Collapse file tree 1 file changed +5
-3
lines changed Expand file tree Collapse file tree 1 file changed +5
-3
lines changed Original file line number Diff line number Diff line change @@ -33,8 +33,10 @@ pub fn new(value: T) -> Rc<T> {
33
33
```
34
34
35
35
This code generates documentation that looks [ like this] [ rc-new ] . I've left the
36
- implementation out, with a regular comment in its place. That's the first thing
37
- to notice about this annotation: it uses ` /// ` , instead of ` // ` . The triple slash
36
+ implementation out, with a regular comment in its place.
37
+
38
+ The first thing to notice about this annotation is that it uses
39
+ ` /// ` instead of ` // ` . The triple slash
38
40
indicates a documentation comment.
39
41
40
42
Documentation comments are written in Markdown.
@@ -375,7 +377,7 @@ $ rustdoc --test path/to/my/crate/root.rs
375
377
$ cargo test
376
378
```
377
379
378
- That's right, ` cargo test ` tests embedded documentation too. However,
380
+ That's right, ` cargo test ` tests embedded documentation too. However,
379
381
` cargo test ` will not test binary crates, only library ones. This is
380
382
due to the way ` rustdoc ` works: it links against the library to be tested,
381
383
but with a binary, there’s nothing to link to.
You can’t perform that action at this time.
0 commit comments