Skip to content

Commit ff0461e

Browse files
Add guideline about "reviewing doc changes"
1 parent 7f7029d commit ff0461e

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

src/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
- [doc alias policy](./documentation/doc-alias-policy.md)
5050
- [safety comments policy](./documentation/safety-comments.md)
5151
- [how to write documentation](./how-to-write-documentation.md)
52+
- [reviewing doc changes](./reviewing-doc-changes.md)
5253

5354
---
5455

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Reviewing doc changes
2+
3+
Most of the time, it is mostly reviewing that the documentation isn't wrong
4+
in any way and that it follows the
5+
[how to write documentation](./how-to-write-documentation.md) guideline.
6+
7+
There is however something where we need to be extra careful: stability
8+
guarantees.
9+
10+
## Stability guarantees
11+
12+
First, short explanation about what a stability guarantee is: a statement in
13+
the document which explains what the item is doing in a precise case. For
14+
example:
15+
16+
* Showing precisely how a function on floats handles `NaN`.
17+
* Saying that a sort method has a particular running-time bound.
18+
19+
So if a doc change updates/adds/removes a stability guarantee, it has to be
20+
**very** carefully handled and needs to go through the
21+
[libs API team FCP](https://rustc-dev-guide.rust-lang.org/stabilization_guide.html?highlight=fcp#fcp).
22+
23+
It can be circumvented by adding a `# Current Implementation` section
24+
[like done here](https://github.com/rust-lang/rust/blob/4a8d2e3856c0c75c71998b6c85937203839b946d/library/alloc/src/slice.rs#L250).

src/documentation/summary.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
- [doc alias policy](./doc-alias-policy.md)
22
- [safety comments policy](./safety-comments.md)
33
- [how to write documentation](./how-to-write-documentation.md)
4+
- [reviewing doc changes](./reviewing-doc-changes.md)

0 commit comments

Comments
 (0)