diff options
| author | Tshepang Lekhonkhobe <tshepang@gmail.com> | 2015-06-22 19:26:51 +0200 |
|---|---|---|
| committer | Tshepang Lekhonkhobe <tshepang@gmail.com> | 2015-06-22 19:29:29 +0200 |
| commit | 0adda45c04f1c4a950e1e676ae590758c7b827df (patch) | |
| tree | 7c2daa5785d6c478d1c0cbf511317d2810fc192c | |
| parent | 1671b9baeceeb38ddb7366668d28e3a7ee839ef3 (diff) | |
| download | rust-0adda45c04f1c4a950e1e676ae590758c7b827df.tar.gz rust-0adda45c04f1c4a950e1e676ae590758c7b827df.zip | |
book: fix sentence
| -rw-r--r-- | src/doc/trpl/documentation.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/doc/trpl/documentation.md b/src/doc/trpl/documentation.md index 53754e2688d..746558b3b94 100644 --- a/src/doc/trpl/documentation.md +++ b/src/doc/trpl/documentation.md @@ -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. |
