From e3596e34cef60fc794ae98f87eb2e6614827ce0a Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Sat, 3 Oct 2015 00:08:14 +0300 Subject: [PATCH 1/2] docs: whitespace cleanup --- CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc5447a1cda..940365e2504 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -145,7 +145,7 @@ 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 [A-docs label][adocs]. [adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs @@ -164,30 +164,30 @@ Contributors with sufficient permissions on the Rust repo can help by adding labels to triage issues: * Yellow, **A**-prefixed labels state which **area** of the project an issue - relates to. + relates to. -* Magenta, **B**-prefixed labels identify bugs which **belong** elsewhere. +* Magenta, **B**-prefixed labels identify bugs which **belong** elsewhere. * Green, **E**-prefixed labels explain the level of **experience** necessary to fix the issue. * Red, **I**-prefixed labels indicate the **importance** of the issue. The [I-nominated][inom] label indicates that an issue has been nominated for - prioritizing at the next triage meeting. + prioritizing at the next triage meeting. * Orange, **P**-prefixed labels indicate a bug's **priority**. These labels are only assigned during triage meetings, and replace the [I-nominated][inom] - label. + label. * Blue, **T**-prefixed bugs denote which **team** the issue belongs to. * Dark blue, **beta-** labels track changes which need to be backported into - the beta branches. - -* The purple **metabug** label marks lists of bugs collected by other - categories. + the beta branches. -If you're looking for somewhere to start, check out the [E-easy][eeasy] tag. +* The purple **metabug** label marks lists of bugs collected by other + categories. + +If you're looking for somewhere to start, check out the [E-easy][eeasy] tag. [inom]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated [eeasy]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy From c3753ce07494d25f4bb54023d572d2d84645031a Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Sat, 3 Oct 2015 00:09:27 +0300 Subject: [PATCH 2/2] docs: add rustdoc example to CONTRIBUTING.md --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 940365e2504..515e6e18f70 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,6 +149,11 @@ To find documentation-related issues, sort by the [A-docs label][adocs]. [adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs +In many cases, you don't need a full `make doc`. You can use `rustdoc` directly +to check small fixes. For example, `rustdoc src/doc/reference.md` will render +reference to `doc/reference.html`. The CSS might be messed up, but you can +verify that HTML is right. + ## Issue Triage Sometimes, an issue will stay open, even though the bug has been fixed. And