about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2018-07-04rewrite suggestions intro to be less bizarrely edition/rustfix centricZack M. Davis-9/+13
The suggestions API was introduced in April 2015 (rust-lang/rust@906a9728ff), long predating rustfix (initial commit July 2016) or editions (RFC 2052 approved September 2017).
2018-07-04mention lint-level command line flags as well as attributesZack M. Davis-1/+2
2018-07-04cautionary parenthetical about failing to emit a `DiagnosticBuilder`Zack M. Davis-1/+3
2018-07-04"easier" → "more informative"; omit needless clauseZack M. Davis-1/+1
We don't want to leave the impression that spans are about making it easier for compiler developers to perform the arduous task of emitting an error; spans are about pointing to particular segments of code in the emitted error messages. Also, we don't need to say "whenever an error comes up"; that's implied by the phrase "error reporting."
2018-07-04`span_to_snippet` return value is a `Result`, not an `Option`Zack M. Davis-2/+2
2018-07-04add links for `Span`, `CodeMap`, and `rustfix`Zack M. Davis-14/+19
It's unfortunate that `code-monospaced` links don't render with link colors (such that the reader needs to hover over them just to tell that it is a link), but that's presumably a bug in MdBook, and not something we need concern ourselves with here.
2018-07-04Auto merge of #51803 - lucasem:rustdoc-code-hash-escape, r=GuillaumeGomezbors-0/+17
rustdoc codeblock hash escape So that docstring text such as the following (in a code block) can be created ergonomically: ```rust let s = " foo # bar baz "; ``` Such code in a docstring hide the <code>&nbsp;&nbsp;&nbsp;&nbsp;# bar</code> line. Previously, using two consecutive hashes <code>&nbsp;&nbsp;&nbsp;&nbsp;## bar</code> would turn the line into _shown_ `# bar`, losing the leading whitespace. A line of code like <code>&nbsp;&nbsp;&nbsp;&nbsp;# bar</code> (such as in the example above) **could not be represented** in the docstring text. This commit makes the two consecutive hashes not also trim the leading whitespace — the two hashes simply **escape** into a single hash and do not hide the line, leaving the rest of that line unaffected. The new docstring text to achieve the above code block is: ```rust /// ``` /// let s = " /// foo /// ## bar /// baz /// "; /// ``` ```
2018-07-04rustdoc book on codeblock hash escapingLucas Morales-0/+17
2018-07-04Unstable book documentation of tool lintsflip1995-0/+35
2018-06-26Keep glossary definition of codegenAlex Kitchens-1/+2
2018-06-26Rename trans to codegenAlex Kitchens-5/+5
This commit is a followup of changes from [b63d7e2b1c4019e40051036bcb1fd5f254a8f6e2](https://github.com/rust-lang/rust/commit/b63d7e2b1c4019e40051036bcb1fd5f254a8f6e2#diff-b433c87466d984aa7eeded378ea6c392) in the Rust source to rename trans to codegen.
2018-06-26Auto merge of #49469 - Nokel81:allow-irrefutable-let-patterns, r=nikomatsakisbors-0/+28
Implementation of RFC 2086 - Allow Irrefutable Let patterns This is the set of changes for RFC2086. Tracking issue #44495. Rendered [here](https://github.com/rust-lang/rfcs/pull/2086)
2018-06-25Update query.mdEduard-Mihai Burtescu-3/+1
2018-06-25Update high-level-overview.mdEduard-Mihai Burtescu-1/+1
2018-06-25rustc: rename ty::maps to ty::query.Eduard-Mihai Burtescu-9/+9
2018-06-25don't mention new rustdocZack M. Davis-4/+1
Steve says it's not ready (https://github.com/rust-lang-nursery/rustc-guide/pull/150#issuecomment-395783504).
2018-06-25include `./` in example x.py commands for smoother copy-paste experienceZack M. Davis-2/+2
The current directory is typically not on the user's $PATH.
2018-06-25make the `while let` loop terminateNiko Matsakis-1/+1
2018-06-22Rollup merge of #51158 - ogham:patch-1, r=steveklabnikkennytm-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-18Update books for next releaseMark Simulacrum-0/+0
2018-06-12Capitalize a wordscalexm-2/+2
2018-06-12Add chalk rules for type defsscalexm-1/+75
2018-06-12rustdoc: add --extern-html-root-url flagQuietMisdreavus-0/+15
2018-06-12update wording, do not change parserNiko Matsakis-6/+11
2018-06-12Stabilize #[repr(transparent)]Simon Sapin-176/+0
Tracking issue FCP: https://github.com/rust-lang/rust/issues/43036#issuecomment-394094318 Reference PR: https://github.com/rust-lang-nursery/reference/pull/353
2018-06-11Mark alloc_jemalloc as perma-unstableSimon Sapin-13/+0
2018-06-11Move Unstable Book sections for #[global_allocator] and System to std::alloc ↵Simon Sapin-148/+0
docs
2018-06-11Remove some '#[feature]' attributes for stabilized featuresSimon Sapin-1/+0
2018-06-11Remove alloc::Opaque and use *mut u8 as pointer type for GlobalAllocMike Hommey-3/+3
2018-06-10Merge pull request #149 from rust-lang-nursery/mark-i-m-patch-1Niko Matsakis-3/+10
clarify run-rustfix compiletest header
2018-06-10Merge pull request #153 from mark-i-m/code_index_01Niko Matsakis-7/+23
A few more data structures to the code index
2018-06-10Stabilize entry-or-defaultGuillaume Gomez-13/+0
2018-06-08update trait refMark Mansi-1/+1
2018-06-08removed whitespaceAlexander Regueiro-1/+1
2018-06-08mention blessMark Mansi-0/+4
2018-06-08rename `irrefutable_let_pattern` to `irrefutable_let_patterns`Niko Matsakis-4/+4
2018-06-08Merge pull request #152 from mark-i-m/glossary_moreNiko Matsakis-0/+7
add a bunch of type-related terms to glossary (and few others)
2018-06-05fix buildMark Mansi-2/+2
2018-06-05Add bit about ctags; close #80Mark Mansi-3/+21
2018-06-05Rollup merge of #51183 - teiesti:rustdoc-book-termination, r=steveklabnikMark 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-05Rollup merge of #50852 - mandeep:fix-rustdoc-example-testing, r=GuillaumeGomezMark 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-05Implementation of RFC 2086 - Allow Irrefutable Let patternsSebastian Malton-0/+23
2018-06-05Improve wordingTobias Stolzmann-2/+3
2018-06-05Update rustdoc book to suggest using Termination trait instead of hidden ↵Tobias Stolzmann-11/+29
‘foo’ function
2018-06-04fix typoMark Mansi-1/+1
2018-06-04tests dont need to passMark Mansi-2/+2
2018-06-04long lineMark-1/+2
2018-06-04Address review feedbackMark-9/+16
2018-06-04add more on crater + perf runsMark-0/+17
2018-06-04add a bit about craterMark Mansi-1/+32