From 3b0add459c49efab85dd617d236aa5b0d9687aa2 Mon Sep 17 00:00:00 2001 From: lukaramu Date: Fri, 24 Mar 2017 21:16:00 +0100 Subject: [PATCH 1/2] 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. --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f921fb2c94233..651fffb585add 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 From 7643ccd29ca708059cef446d2ef4446559bb4518 Mon Sep 17 00:00:00 2001 From: lukaramu Date: Fri, 24 Mar 2017 21:28:59 +0100 Subject: [PATCH 2/2] Split paragraph in CONTRIBUTING.md --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 651fffb585add..0314a5dfd8d02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -312,9 +312,11 @@ 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 [T-doc label][tdoc]. -You can find documentation style guidelines in [RFC 1574][rfc1574]. [tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc + +You can find documentation style guidelines in [RFC 1574][rfc1574]. + [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