Skip to content

Commit ac6554b

Browse files
Remove controversial parts of "how to write documentation"
1 parent 5ed4edd commit ac6554b

File tree

1 file changed

+3
-30
lines changed

1 file changed

+3
-30
lines changed

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

+3-30
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,6 @@ This document explains how to write documentation for the std/core public APIs.
44

55
Let's start with some general information:
66

7-
### Contractions
8-
9-
It is common in English to have contractions such as "don't" or "can't". Do not
10-
use these in documentation. Always write their "full form":
11-
12-
* "do not" instead of "don't"
13-
* "cannot" instead of "can't"
14-
* "it would" instead of "it'd"
15-
* "it will" instead of "it'll"
16-
* "it is"/"it has" instead of "it's"
17-
* "you are" instead of "you're"
18-
* "they are" instead of "they're"
19-
* etc
20-
21-
The only exception to this rule is "let's" as it is specific/known/common enough.
22-
23-
The reason is simply to make the reading simpler for as many people as possible.
24-
257
### When to use inline code blocks
268

279
Whenever you are talking about a type or anything code related, it should be in a
@@ -43,16 +25,6 @@ Little note: when you are documenting an item, there is no need to link to it.
4325
So, if you write documentation for the `String::push_str` method, there is
4426
no need to link to the `push_str` method or the `String` type.
4527

46-
If you have cases like `Vec<String>`, you need to use intra-doc links on both
47-
`Vec` and `String` as well. It would look like this:
48-
49-
```text
50-
This is a [`Vec`]`<`[`String`]`>`.
51-
```
52-
53-
Extra explanations: since both `Vec` and `String` are in codeblocks, `<` and `>`
54-
should as well, otherwise it would render badly.
55-
5628
### Code blocks
5729

5830
With rustdoc, code blocks are tested (because they are treated as Rust code
@@ -130,14 +102,15 @@ mentioned! This explanation needs to be prepended by a `Panics` title:
130102
### Examples
131103

132104
As for the examples, they have to show the usage of the function/method. Just
133-
like the `panic` section, they need to be prepended by a `Examples` title.
105+
like the `panic` section, they need to be prepended by a `Example` title (plural
106+
if there is more than one).
134107

135108
It is better if you use `assert*!` macros at the end to ensure that the example
136109
is working as expected. It also allows the readers to understand more easily
137110
what the function is doing (or returning).
138111

139112
````text
140-
# Examples
113+
# Example
141114
142115
```
143116
let s = MyType::new("hello ");

0 commit comments

Comments
 (0)