about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2018-08-01Rollup merge of #52831 - dsciarra:rm-ref-to-author-file, r=alexcrichtonPietro Albini-1/+1
remove references to AUTHORS.txt file Rust does not ship an AUTHORS.txt file anymore.
2018-07-31Auto merge of #52863 - steveklabnik:update-books, r=Mark-Simulacrumbors-0/+0
update books for new release r? @Mark-Simulacrum
2018-07-30update books for new releasesteveklabnik-0/+0
2018-07-30Remove references to AUTHORS.txt fileDonato Sciarra-1/+1
Refer instead to thanks page.
2018-07-28Auto merge of #52711 - eddyb:unsized-manuallydrop, r=nikomatsakisbors-0/+0
Change ManuallyDrop<T> to a lang item. This PR implements the approach @RalfJung proposes in https://internals.rust-lang.org/t/pre-rfc-unions-drop-types-and-manuallydrop/8025 (lang item `struct` instead of `union`). A followup PR can easily solve #47034 as well, by just adding a few `?Sized` to `libcore/mem.rs`. r? @nikomatsakis
2018-07-27uodate reference again to hopefully fix all link issuesRalf Jung-0/+0
2018-07-27add section in booktoidiu-0/+45
2018-07-27update reference to fix linksRalf Jung-0/+0
2018-07-23update nightly bookmark-2/+4
2018-07-18Fix 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-17Rollup merge of #52338 - RalfJung:miri, r=oli-obkkennytm-241/+0
update miri
2018-07-16rustc: Stabilize much of the `proc_macro` featureAlex Crichton-241/+0
This commit stabilizes some of the `proc_macro` language feature as well as a number of APIs in the `proc_macro` crate as [previously discussed][1]. This means that on stable Rust you can now define custom procedural macros which operate as attributes attached to items or `macro_rules!`-like bang-style invocations. This extends the suite of currently stable procedural macros, custom derives, with custom attributes and custom bang macros. Note though that despite the stabilization in this commit procedural macros are still not usable on stable Rust. To stabilize that we'll need to stabilize at least part of the `use_extern_macros` feature. Currently you can define a procedural macro attribute but you can't import it to call it! A summary of the changes made in this PR (as well as the various consequences) is: * The `proc_macro` language and library features are now stable. * Other APIs not stabilized in the `proc_macro` crate are now named under a different feature, such as `proc_macro_diagnostic` or `proc_macro_span`. * A few checks in resolution for `proc_macro` being enabled have switched over to `use_extern_macros` being enabled. This means that code using `#![feature(proc_macro)]` today will likely need to move to `#![feature(use_extern_macros)]`. It's intended that this PR, once landed, will be followed up with an attempt to stabilize a small slice of `use_extern_macros` just for procedural macros to make this feature 100% usable on stable. [1]: https://internals.rust-lang.org/t/help-stabilize-a-subset-of-macros-2-0/7252
2018-07-16update nomiconRalf Jung-0/+0
2018-07-14Update lint plugin sample code.eonil-0/+2
2018-07-06Auto merge of #52018 - flip1995:rfc2103, r=oli-obkbors-0/+35
Implementation of tool lints. Tracking issue: #44690
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-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-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-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-10Stabilize entry-or-defaultGuillaume Gomez-13/+0
2018-06-08rename `irrefutable_let_pattern` to `irrefutable_let_patterns`Niko Matsakis-4/+4
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-03s/panic_fmt/panic_impl/g in docsJorge Aparicio-17/+18
2018-05-29Phrasing tweak in doctest docsBenjamin Sago-1/+1
2018-05-29Mention spec and indented blocks in doctest docsBenjamin 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-27Auto merge of #51066 - est31:master, r=sfacklerbors-2/+2
Point to the current box syntax tracking issue The issue was used for both box syntax as well as placement new. It got closed due to placement new being unapproved. So a new one got created for box syntax, yet neither the unstable book nor feature_gate.rs got updated. We are doing this now. r? @aidanhs
2018-05-26Point to the current box syntax tracking issueest31-2/+2
The issue was used for both box syntax as well as placement new. It got closed due to placement new being unapproved. So a new one got created for box syntax, yet neither the unstable book nor feature_gate.rs got updated. We are doing this now.
2018-05-26Add `Ident::as_str` helperVadim Petrochenkov-1/+1
2018-05-26Auto merge of #50070 - toidiu:ak-2093-outlives, r=nikomatsakisbors-0/+67
2093 infer outlives requirements Tracking issue: #44493 RFC: https://github.com/rust-lang/rfcs/pull/2093 - [x] add `rustc_attrs` flag - [x] use `RequirePredicates` type - [x] handle explicit predicates on `dyn` Trait - [x] handle explicit predicates on projections - [x] more tests - [x] remove `unused`, `dead_code` and etc.. - [x] documentation
2018-05-25Implement outlives requirements inference for dyn and projections.toidiu-0/+67
Add tests, documentation and attr for feature.
2018-05-25Fix naming conventions for new lintsVadim Petrochenkov-1/+1
2018-05-22build the 2018 editionsteveklabnik-0/+0
2018-05-20Rollup merge of #50858 - robinkrahl:rustdoc-fix-order, r=steveklabnikkennytm-8/+8
Reorder description for snippets in rustdoc documentation 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-05-19Auto merge of #50760 - petrochenkov:legimp, r=nikomatsakisbors-37/+0
Turn deprecation lint `legacy_imports` into a hard error Closes https://github.com/rust-lang/rust/issues/38260 The lint was introduced in Dec 2016, then made deny-by-default in Jun 2017 when crater run found 0 regressions caused by it. This lint requires some not entirely trivial amount of import resolution logic that (surprisingly or not) interacts with `feature(use_extern_macros)` (https://github.com/rust-lang/rust/issues/35896), so it would be desirable to remove it before stabilizing `use_extern_macros`. In particular, this PR fixes the failing example in https://github.com/rust-lang/rust/issues/50725 (but not the whole issue, `use std::panic::{self}` still can cause other undesirable errors when `use_extern_macros` is enabled).
2018-05-18Add println statement to rendered code block examplemandeep-0/+1
2018-05-18Add doc comment to hiding portions of code examplemandeep-2/+3
Refactor hiding example to be more complete
2018-05-18Reorder description for snippets in rustdoc documentationRobin 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.