bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Auto merge of #28815 - matklad:contrib-doc, r=steveklabnik

Browse source 
This adds a paragraph on how to generate documentation without sloooow `make doc`. I'm not a native English speaker, so there might be some language related bugs (I wish English was as hard to get wrong, as Rust)

This also includes whitespace cleanup of contributing.md in a separate commit. Whiltespace is not significant in github flavored markdown, and my Emacs just cleans ws automatically :)

r? @steveklabnik
This commit is contained in:
bors 2015-10-03 07:50:47 +00:00
commit 4665aaebfd
1 changed files with 15 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

5
CONTRIBUTING.md
View file

@ -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