diff options
| author | lukaramu <lukaramu@users.noreply.github.com> | 2017-03-24 21:16:00 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-24 21:16:00 +0100 |
| commit | 3b0add459c49efab85dd617d236aa5b0d9687aa2 (patch) | |
| tree | 058c47b53729404858f5847cef930d94129fe6e2 | |
| parent | f2036c7be4e783f459d1f9a712c5a7b3ef6679bd (diff) | |
| download | rust-3b0add459c49efab85dd617d236aa5b0d9687aa2.tar.gz rust-3b0add459c49efab85dd617d236aa5b0d9687aa2.zip | |
Update CONTRIBUTING.md
Changed link to documentation issues from A-docs to T-doc as this has just been migrated. Added a link to the documentation style guidelines.
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f921fb2c942..651fffb585a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -311,9 +311,11 @@ To save @bors some work, and to get small changes through more quickly, when the other rollup-eligible patches too, and they'll get tested and merged at the same time. -To find documentation-related issues, sort by the [A-docs label][adocs]. +To find documentation-related issues, sort by the [T-doc label][tdoc]. +You can find documentation style guidelines in [RFC 1574][rfc1574]. -[adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs +[tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc +[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text In many cases, you don't need a full `./x.py doc`. You can use `rustdoc` directly to check small fixes. For example, `rustdoc src/doc/reference.md` will render |