You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: reference-dev-guide/src/introduction.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,27 +8,27 @@ It is encouraged for you to read the [introduction] of the Reference to familiar
8
8
9
9
## Critiquing the Reference
10
10
11
-
This is the easiest way to contribute. Basically, as you read the Reference, if you find something confusing, incorrect, or missing, then you can file an issue against the Reference explaining your concerns.
11
+
This is the easiest way to contribute. As you read the Reference, if you find something confusing, incorrect, or missing, then you can file an issue against the Reference explaining your concerns.
12
12
13
13
## Editing the Reference
14
14
15
15
Typos and incorrect links get through from time to time. Should you find them, we welcome PRs to fix them.
16
16
17
17
## Adding examples and glossary entries
18
18
19
-
Examples are great. Many people will only read examples and ignore the prose. Ideally, every facet of every feature will have an example.
19
+
Examples are great. Many people will only read examples and ignore the prose. Ideally, every facet of every feature should have an example.
20
20
21
-
Likewise, the Reference has a glossary. It doesn't need to explain every facet of every feature nor contain every definition, but it does need to be expanded upon. Ideally entries in the glossary link to the associated documentation.
21
+
Likewise, the Reference has a glossary. It doesn't need to explain every facet of every feature nor contain every definition, but it does need to be expanded upon. Ideally, entries in the glossary should link to the associated documentation.
22
22
23
23
## Adding documentation
24
24
25
-
There are a lot of features that are not documented at all or are documented poorly. This is the hardest, but definitely most valuable. Pick an unassigned issue from the [issue tracker], and write about it.
25
+
There are a lot of features that are not documented at all or are documented poorly. This is the hardest task, but definitely the most valuable. Pick an unassigned issue from the [issue tracker], and write about it.
26
26
27
27
While writing, you may find it handy to have a [playground] open to test out what you are documenting.
28
28
29
29
Feel free to take information from the standard library and Rustonomicon as appropriate.
30
30
31
-
Note that we don't write documentation for purely library features such as threads and IO and we don't write about Rust in the future. Documentation is written as if the current stable release of Rust is the last release. The `master` branch of the Reference corresponds to what is **stable** on the `master` branch ("nightly") of [rust-lang/rust]. If you want to write about Rust in the future, you want [the Unstable book][unstable].
31
+
Note that we don't write documentation for purely library features, such as threads and IO, and we don't write about Rust in the future. Documentation is written as if the current stable release of Rust is the last release. The `master` branch of the Reference corresponds to what is **stable** on the `master` branch ("nightly") of [rust-lang/rust]. If you want to write about Rust in the future, you want [the Unstable book][unstable].
0 commit comments