Skip to content

Commit e17d43f

Browse files
Updates on "how to write documentation"
1 parent f513a22 commit e17d43f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/documentation/how-to-write-documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Intra-doc links (you can see the full explanations for the feature
3939
[here](https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html))
4040
should be used as much as possible whenever a type is mentioned.
4141

42-
Little note: when you are documenting an item, no need to link to it. So if you
43-
write documentation for `String::push_str` method, no need to link to the method
44-
`push_str` or to the `String` type.
42+
Little note: when you are documenting an item, there is no need to link to it.
43+
So, if you write documentation for the `String::push_str` method, there is
44+
no need to link to the `push_str` method or the `String` type.
4545

4646
If you have cases like `Vec<String>`, you need to use intra-doc links on both
4747
`Vec` and `String` as well. It would look like this:

0 commit comments

Comments
 (0)