| Age | Commit message (Collapse) | Author | Lines | |
|---|---|---|---|---|
| 2018-07-18 | Fix links in rustdoc book. | Eric Huss | -2/+2 | |
| Due to a change in how mdbook generates section anchors, headers with non-alphabetic characters now start with "a". | ||||
| 2018-07-04 | rustdoc book on codeblock hash escaping | Lucas Morales | -0/+17 | |
| 2018-06-22 | Rollup merge of #51158 - ogham:patch-1, r=steveklabnik | kennytm | -0/+24 | |
| Mention spec and indented blocks in doctest docs Fixes #49717. This commit adds a new section to the Documentation Test docs, which briefly mentions indented code blocks, and links to the CommonMark specification for both. I’m not sure about saying "fenced code blocks the more popular choice in the Rust community” because it seems like I’m speaking for everyone, but I can’t think of a better way to phrase it! | ||||
| 2018-06-05 | Rollup merge of #51183 - teiesti:rustdoc-book-termination, r=steveklabnik | Mark Simulacrum | -11/+30 | |
| Update rustdoc book to suggest using Termination trait instead of hidden ‘foo’ function Closes #50721. I suggest that someone double-checks my English since I am not a native speaker. r? @steveklabnik | ||||
| 2018-06-05 | Rollup merge of #50852 - mandeep:fix-rustdoc-example-testing, r=GuillaumeGomez | Mark Simulacrum | -2/+4 | |
| Add doc comment to hiding portions of code example fixes #50816 Not sure if this is all that's needed, but I think it's a good start. One thing to note is that the code block is a text block where it could possibly be a rust block. | ||||
| 2018-06-05 | Improve wording | Tobias Stolzmann | -2/+3 | |
| 2018-06-05 | Update rustdoc book to suggest using Termination trait instead of hidden ↵ | Tobias Stolzmann | -11/+29 | |
| ‘foo’ function | ||||
| 2018-05-29 | Phrasing tweak in doctest docs | Benjamin Sago | -1/+1 | |
| 2018-05-29 | Mention spec and indented blocks in doctest docs | Benjamin Sago | -0/+24 | |
| This commit adds a new section to the Documentation Test docs, which briefly mentions indented code blocks, and links to the CommonMark specification for both. I’m not sure about saying "fenced code blocks the more popular choice in the Rust community” because it seems like I’m speaking for everyone, but I can’t think of a better way to phrase it! | ||||
| 2018-05-18 | Add println statement to rendered code block example | mandeep | -0/+1 | |
| 2018-05-18 | Add doc comment to hiding portions of code example | mandeep | -2/+3 | |
| Refactor hiding example to be more complete | ||||
| 2018-05-18 | Reorder description for snippets in rustdoc documentation | Robin Krahl | -8/+8 | |
| The example code snippets for the `no_run` and `compile_fail` attributes in the rustdoc documentation were followed by the description for the wrong attribute. This patch reorders the descriptions to match the code snippets. | ||||
| 2018-04-22 | Add doc about doc alias feature | Guillaume Gomez | -0/+16 | |
| 2018-04-17 | Rollup merge of #49994 - frewsxcv:frewsxcv-doc-tests, r=QuietMisdreavus | kennytm | -19/+19 | |
| Remove unnecessary indentation in rustdoc book codeblock. None | ||||
| 2018-04-16 | Remove unnecessary indentation in rustdoc book codeblock. | Corey Farwell | -19/+19 | |
| 2018-04-13 | add -C to the rustdoc book | QuietMisdreavus | -0/+25 | |
| 2018-04-01 | Rollup merge of #49451 - QuietMisdreavus:epoch-doctests, r=GuillaumeGomez | Mark Simulacrum | -0/+13 | |
| rustdoc: add an --edition flag to compile docs/doctests with a certain edition To correspond with the 2018 edition, this adds a (currently unstable) `--edition` flag to rustdoc that makes it compile crates and doctests with the given edition. Once this lands, Cargo should be updated to pass this flag when the edition configuration option is given. | ||||
| 2018-03-29 | Rename main theme into light theme | Guillaume Gomez | -3/+3 | |
| 2018-03-27 | talk about --edition in the Rustdoc Book | QuietMisdreavus | -0/+13 | |
| 2018-03-23 | Rollup merge of #49028 - ↵ | Alex Crichton | -0/+363 | |
| QuietMisdreavus:the-dark-forbidden-corners-of-rustdoc, r=frewsxcv add an "unstable features" chapter to the rustdoc book There are several rustdoc features that currently are undocumented, but also don't fit with the rest of the Rustdoc Book since they're also unstable. Some of these have corresponding feature gates and chapters in the Unstable Book, but many don't, and i wanted a place to talk about them officially. Goal: talk about everything rustdoc can do that needs nightly - [x] Feature gates (extensions to the doc attribute that can be caught by the compiler) - [x] doc(cfg) - [x] doc(masked) - [x] doc(spotlight) - [x] doc(include) - [x] Command-line flags (features that require a CLI flag to use, where the flag itself is a `-Z` command or otherwise requires `-Z unstable-options` before rustdoc will accept it) - [x] markdown-before-content/markdown-after-content - [x] playground-url - [x] display-warnings - [x] crate-version - [x] linker - [x] sort-modules-by-appearance - [x] themes/theme-checker - [x] resource-suffix - [x] `-Z force-unstable-if-unmarked` - [x] Nightly-gated functionality (features that are gated by requiring a nightly build without needing a CLI flag or a feature gate to unlock) - [x] intra-links - [x] error numbers for `compile_fail` doctests | ||||
| 2018-03-21 | review comments | QuietMisdreavus | -11/+13 | |
| 2018-03-20 | talk about force-unstable-if-unmarked | QuietMisdreavus | -0/+13 | |
| 2018-03-20 | talk about --display-warnings | QuietMisdreavus | -0/+16 | |
| 2018-03-16 | talk about --resource-suffix | QuietMisdreavus | -0/+13 | |
| 2018-03-16 | talk about --themes and --theme-checker | QuietMisdreavus | -0/+24 | |
| 2018-03-16 | talk about --sort-modules-by-appearance | QuietMisdreavus | -0/+13 | |
| 2018-03-16 | talk about --linker | QuietMisdreavus | -0/+13 | |
| 2018-03-16 | talk about --crate-version | QuietMisdreavus | -0/+12 | |
| 2018-03-15 | talk about --playground-url | QuietMisdreavus | -0/+23 | |
| 2018-03-16 | Rollup merge of #48961 - Songbird0:rustdoc_doctests_assertions, r=GuillaumeGomez | kennytm | -0/+16 | |
| Rustdoc: example of use of assertions I added this section at the beginning of the file because it seems to be basic information. Let me know if there's someplace more relevant. See #47945. | ||||
| 2018-03-15 | talk about --markdown-(before|after)-content | QuietMisdreavus | -0/+28 | |
| 2018-03-15 | add new section about CLI flags | QuietMisdreavus | -0/+7 | |
| 2018-03-15 | fix link | QuietMisdreavus | -1/+1 | |
| 2018-03-14 | add headings to categorize the features | QuietMisdreavus | -6/+18 | |
| 2018-03-14 | talk about doc(include) | QuietMisdreavus | -3/+19 | |
| 2018-03-14 | talk about doc(masked) | QuietMisdreavus | -0/+20 | |
| 2018-03-14 | talk about doc(spotlight) | QuietMisdreavus | -0/+20 | |
| 2018-03-14 | talk about doc(cfg) | QuietMisdreavus | -0/+52 | |
| 2018-03-13 | talk about intra-links | QuietMisdreavus | -0/+45 | |
| 2018-03-13 | Add a section for using assertions into doc tests. | Anthony Defranceschi | -0/+16 | |
| See #47945. | ||||
| 2018-03-12 | talk about error numbers for compile_fail doctests | QuietMisdreavus | -0/+23 | |
| 2018-03-12 | add page to the Rustdoc Book about unstable features | QuietMisdreavus | -0/+11 | |
| 2018-03-12 | big fences to show that ```rust is the same as ``` | QuietMisdreavus | -0/+4 | |
| 2018-01-15 | Reexport -> re-export in documentation section headings | Carol (Nichols || Goulding) | -3/+3 | |
| 2017-11-21 | fix some typos | Martin Lindhe | -3/+3 | |
| 2017-11-04 | rustdoc book: talk about #![doc(test(...))] in doctests chapter | QuietMisdreavus | -6/+8 | |
| 2017-11-04 | rustdoc book: add #![doc(test(no_crate_inject))] and #![doc(test(attr(...)))] | QuietMisdreavus | -0/+20 | |
| 2017-10-17 | Rollup merge of #45308 - dbrgn:headlines, r=steveklabnik | kennytm | -3/+3 | |
| Rustdoc book: Add missing headlines Some options were missing headlines, which looked a bit inconsistent. | ||||
| 2017-10-15 | Rustdoc book: Add missing headlines | Danilo Bargen | -3/+3 | |
| Some options were missing headlines, which looked a bit inconsistent. | ||||
| 2017-10-15 | Fix typo in rustdoc book | Danilo Bargen | -3/+3 | |
