summary refs log tree commit diff
path: root/src/doc/book/documentation.md
AgeCommit message (Collapse)AuthorLines
2016-12-23book: replace example I do not understandTshepang Lekhonkhobe-2/+3
2016-11-13Improved punctuation, capitalization, and sentence structure of code snippet ↵Angelo Polo-2/+2
comments
2016-07-05Add a section about crate documentation.Kaivo Anastetiks-0/+11
2016-06-01Fix a few links in the bookOliver Middleton-1/+1
Links to directories and direct links to doc.rust-lang.org don't work properly when viewing the docs offline so fix them.
2016-05-18Rust syntax coloring for some ignore, should-panic and no-run snippets.Steven Burns-6/+6
2016-02-10Fix documentation example in the bookOliver Middleton-3/+3
The code sections shouldn't be inside a ```text block.
2016-02-01book: Change "Failures" to "Errors" in doc special sections chapterKamal Marhubi-1/+1
This matches the usage in the standard library's documentation.
2016-01-09Remove many instances of 'just'Steve Klabnik-3/+3
Doing so is considered weaker writing. Thanks @Charlotteis! Fixes #28810
2015-12-21Revert to colon. The text is introducing a list.Luke Jones-1/+1
2015-12-21Rewrite paragraph in 'match' to be more concise and readable. StartLuke Jones-4/+4
correcting use of ':' in sentences. The colon `:` should be used only when the sentence preceeding it is a complete sentence. If this is not the case, then a `;` should be used; this denotes that the following fragment is a part of the previous fragment.
2015-12-01trpl: explain how to inhibit rustdoc's auto-mainAlex Burka-9/+16
I think this fixes #30137. I basically just repeated some details that were scattered around other places in this document, and emphasized that you probably don't want an `extern crate` or `mod` statement to end up inside a function.
2015-11-19src/doc/trpl -> src/doc/bookSteve Klabnik-0/+653
The book was located under 'src/doc/trpl' because originally, it was going to be hosted under that URL. Late in the game, before 1.0, we decided that /book was a better one, so we changed the output, but not the input. This causes confusion for no good reason. So we'll change the source directory to look like the output directory, like for every other thing in src/doc.