diff options
| author | Aleksey Kladov <aleksey.kladov@gmail.com> | 2015-10-03 00:09:27 +0300 |
|---|---|---|
| committer | Aleksey Kladov <aleksey.kladov@gmail.com> | 2015-10-03 03:42:28 +0300 |
| commit | c3753ce07494d25f4bb54023d572d2d84645031a (patch) | |
| tree | c3723eb21886f5e06bd3797bb5994aa65290b47f /CONTRIBUTING.md | |
| parent | e3596e34cef60fc794ae98f87eb2e6614827ce0a (diff) | |
| download | rust-c3753ce07494d25f4bb54023d572d2d84645031a.tar.gz rust-c3753ce07494d25f4bb54023d572d2d84645031a.zip | |
docs: add rustdoc example to CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 5 insertions, 0 deletions
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 |