summary refs log tree commit diff
path: root/src/doc/trpl/documentation.md
AgeCommit message (Collapse)AuthorLines
2015-10-27Auto merge of #29309 - rjbs:doc-comment-sections, r=alexcrichtonbors-37/+35
As displayed before this commit, I found the book confusing in its explanation of `#`-led comments in `rust` blocks. Possibly the biggest confusion was because the many-dashes construct does not become an HR element in the Markdown translator used, so things were not being properly set off. This change should more clearly show the as-rendered content as rendered, and the as-coded content as code.
2015-10-25reformat the docs for hidden code in rust sectionsRicardo Signes-37/+35
As displayed before this commit, I found the book confusing in its explanation of `#`-led comments in `rust` blocks. Possibly the biggest confusion was because the many-dashes construct does not become an HR element in the Markdown translator used, so things were not being properly set off. This change should more clearly show the as-rendered content as rendered, and the as-coded content as code.
2015-10-24Fix docattr to match surrounding textKevin Butler-1/+1
As is, this attr would lead to the "///" prefix being in the output text
2015-10-21Auto merge of #29017 - ykomatsu:trpl, r=steveklabnikbors-5/+6
2015-10-19Clean whitespaceCarlos Liam-1/+1
Remove leading newlines; replace lines containing only whitespace with empty lines; replace multiple trailing newlines with a single newline; remove trailing whitespace in lines
2015-10-13Fix some typosYoshito Komatsu-5/+6
2015-10-09trpl: mention doc(hidden)panicbit-0/+7
2015-10-09trpl: missing documentation wordingpanicbit-2/+2
2015-10-09trpl: mention missing_docs lintpanicbit-0/+25
2015-10-02Add in some <hr>s for emphasisSteve Klabnik-0/+8
It's not really clear here, since the example is rendered, where it starts and ends. So let's use <hr>s to split it up.
2015-09-30Fix module links in std::fmt and the Rust book's documentation chapter.Ted Mielczarek-2/+2
The links in the rustdoc for several places in fmt were trying to link to the std::fmt module but actually linking to std, which was confusing. While trying to figure out why I noticed that the documentation chapter of the Rust book has examples that show this same bug (although it doesn't seem widespread in practice).
2015-08-22Rollup merge of #27934 - MatejLach:spacing_fix, r=steveklabnikSteve Klabnik-2/+2
r @steveklabnik ?
2015-08-21fix spacing issue in trpl/documentation docMatej Ľach-2/+2
2015-08-20emphasize that doctests don't run in bin cratesAlex Burka-6/+6
2015-08-09Use https URLs to refer to rust-lang.org where appropriate.Eli Friedman-4/+4
Also fixes a few outdated links.
2015-06-30Rollup merge of #26506 - tshepang:doc-fix, r=steveklabnikSteve Klabnik-3/+5
2015-06-24Auto merge of #26509 - tshepang:4-and-not-3, r=blussbors-2/+2
2015-06-22book: there are 4 special sectionsTshepang Lekhonkhobe-2/+2
2015-06-22book: remove a stray code blockTshepang Lekhonkhobe-5/+0
2015-06-22book: whitespaceTshepang Lekhonkhobe-1/+1
2015-06-22book: fix sentenceTshepang Lekhonkhobe-2/+4
2015-05-20trpl: Remove tailing semicolon of an inner attributeIven Hsu-1/+1
The syntax with tailing semicolon is deprecated and the compiler will complain about it.
2015-05-18TRPL: Add `rust` Marker to Some Code BlockPascal Hertleif-29/+29
This adds strictly more information to the source files and reduces the need for customized tooling to render the book. (While this should not change the output of _rustbook_, it is very useful when rendering the sources with external tools like Pandoc.)
2015-04-25A number of spell-checking corrections.Przemysław Wesołek-1/+1
2015-04-16Make note of documentation tests and binariesSteve Klabnik-1/+4
Fixes #24228
2015-04-16Make note of possible XSS in RustdocSteve Klabnik-0/+10
Fixes #24160
2015-03-29Auto merge of #23830 - petrochenkov:spellcheck, r=steveklabnikbors-1/+1
With help of https://github.com/lucasdemarchi/codespell r? @steveklabnik
2015-03-29Fix typoHuachao Huang-1/+1
2015-03-28Fix some typosVadim Petrochenkov-1/+1
2015-03-26syntax: Remove support for #[should_fail]Alex Crichton-1/+1
This attribute has been deprecated in favor of #[should_panic]. This also updates rustdoc to no longer accept the `should_fail` directive and instead renames it to `should_panic`.
2015-03-23Test fixes and rebase conflicts, round 2Alex Crichton-1/+2
2015-03-23rollup merge of #23598: brson/gateAlex Crichton-8/+11
Conflicts: src/compiletest/compiletest.rs src/libcollections/lib.rs src/librustc_back/lib.rs src/libserialize/lib.rs src/libstd/lib.rs src/libtest/lib.rs src/test/run-make/rustdoc-default-impl/foo.rs src/test/run-pass/env-home-dir.rs
2015-03-23rustdoc: interpret all leading feature attributes in examples as crate ↵Brian Anderson-8/+11
attributes This makes it possible to write `#![feature(foo)]` in doc tests.
2015-03-22Document how to document macrosSteve Klabnik-0/+35
Fixes #23571
2015-03-15Strip trailing whitespaceTamir Duberstein-5/+5
2015-03-15Strip all leading/trailing newlinesTamir Duberstein-1/+0
2015-03-04TRPL: DocumentationSteve Klabnik-214/+419
This chapter covers writing documentation in depth. Fixes #4361 Fixes #12862 Fixes #14070 Fixes #14967
2015-02-17fix doctestManish Goregaokar-1/+1
2015-02-17Rollup merge of #22027 - iblech:patch-1, r=steveklabnikManish Goregaokar-1/+1
The first commit adds a short note which I believe will reduce worries in people who work with closures very often and read the Rust book for their first time. The second commit consists solely of tiny typo fixes. In some cases, I changed "logical" quotations like She said, "I like programming". to She said, "I like programming." because the latter seems to be the prevalent style in the book.
2015-02-16Tiny typo changes (per discussion in pull request #22027)Ingo Blechschmidt-1/+1
2015-02-13Make note of doc duplication with reexportsSteve Klabnik-1/+24
Fixes #16645
2015-02-07Fix several tiny typosIngo Blechschmidt-1/+1
2015-01-21Move rustdoc.md into the bookSteve Klabnik-0/+296
Fixes #21430