Skip to content

Commit 6248caa

Browse files
committed
Apply some light edits to the introduction
This introduction should probably receive deeper edits to make it fit into the guide better.
1 parent 9bba152 commit 6248caa

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

reference-dev-guide/src/introduction.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@ It is encouraged for you to read the [introduction] of the Reference to familiar
88

99
## Critiquing the Reference
1010

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.
1212

1313
## Editing the Reference
1414

1515
Typos and incorrect links get through from time to time. Should you find them, we welcome PRs to fix them.
1616

1717
## Adding examples and glossary entries
1818

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.
2020

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.
2222

2323
## Adding documentation
2424

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.
2626

2727
While writing, you may find it handy to have a [playground] open to test out what you are documenting.
2828

2929
Feel free to take information from the standard library and Rustonomicon as appropriate.
3030

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].
3232

3333
[Authoring Guide]: docs/authoring.md
3434
[introduction]: src/introduction.md

0 commit comments

Comments
 (0)