about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2018-01-19move over the `ty` READMENiko Matsakis-2/+166
2018-01-19add in the trait resolution README from rustcNiko Matsakis-0/+484
2018-01-19remove the `chap-NNN-` convention from file namesNiko Matsakis-17/+17
I don't want those showing up in the URLs.
2018-01-19replace "conventions" with "high-level overview"Niko Matsakis-2/+142
Also bring in material from the librustc README.md
2018-01-19add an "about this guide" sectionNiko Matsakis-0/+15
2018-01-17add link to gh-pagesNiko Matsakis-0/+2
2018-01-17remove `src/src` directory that somehow got createdNiko Matsakis-0/+0
2018-01-17improve the READMENiko Matsakis-3/+25
2018-01-17Punctuation and clarity fixes.James Mantooth-3/+3
2018-01-17Created a couple basic CI scriptsMichael Bryan-0/+33
2018-01-16add Rust By Example to the bookshelfQuietMisdreavus-0/+2
2018-01-16Merge pull request #4 from mark-i-m/glossaryNiko Matsakis-1/+32
Add glossary
2018-01-16Add glossaryMark Mansi-1/+32
2018-01-17Update README.mdJonathan Turner-1/+1
2018-01-16add outline and chaptersNiko Matsakis-5/+41
2018-01-16add code-of-conduct, licensing material, and a READMENiko Matsakis-0/+265
2018-01-16add `mdbook init`Niko Matsakis-0/+5
2018-01-16Implement repr(transparent)Robin Kruppe-0/+176
2018-01-15Reexport -> re-export in documentation section headingsCarol (Nichols || Goulding)-3/+3
2018-01-15Rollup merge of #47414 - est31:master, r=alexcrichtonkennytm-0/+0
Enforce dashes in the unstable book file names Also rename the existing underscore using files to use dashes. Fixes #47394.
2018-01-13Adding RBE as a submodule #46194projektir-0/+0
2018-01-13Enforce dashes in the unstable book file namesest31-0/+0
Also rename the existing underscore using files to use dashes. Fixes #47394.
2018-01-09Rollup merge of #47301 - GuillaumeGomez:fix-error-index-display, ↵Corey Farwell-223/+266
r=QuietMisdreavus Fix error index display Fixes #47284. r? @QuietMisdreavus
2018-01-09Fix error index displayGuillaume Gomez-223/+266
2018-01-03Add docs for `crate_in_paths`, `extern_in_paths` and `extern_absolute_paths` ↵Vadim Petrochenkov-0/+137
into the unstable book
2018-01-03Rollup merge of #47117 - tinaun:no_more_dups, r=frewsxcvkennytm-7/+0
[unstable book] remove duplicate entries if a unstable feature is a language feature, it shouldn't also have a library feature stub generated
2018-01-01Auto merge of #46895 - ricochet1k:macro-lifetimes, r=jseyfriedbors-0/+14
Allow lifetimes in macros This is a resurrection of PR #41927 which was a resurrection of #33135, which is intended to fix #34303. In short, this allows macros_rules! to use :lifetime as a matcher to match 'lifetimes. Still to do: - [x] Feature gate
2017-12-30update books for next releasesteveklabnik-0/+0
2017-12-28Add an entry in the unstable bookMatt Peterson-0/+14
2017-12-07fix markdown file differencesGuillaume Gomez-7/+7
2017-12-04template month/year, version into man pages while building dist tarballZack M. Davis-2/+2
This is meant to resolve #25689.
2017-12-03Fix invalid link to lint_plugin_test.rsKenjiro Nakayama-1/+1
2017-11-30Implement RFC 2128 (use_nested_groups)Pietro Albini-0/+90
This commit adds support for nested groups inside `use` declarations, such as `use foo::{bar, sub::{baz::Foo, *}};`.
2017-11-28Rollup merge of #46174 - stjepang:stabilize-spinloophint, r=sfacklerkennytm-41/+0
Stabilize spin_loop_hint Stabilize `spin_loop_hint` in release `1.23.0`. I've also renamed feature `hint_core_should_pause` to `spin_loop_hint`. cc #41196
2017-11-22Remove spin-loop-hint from the unstable bookStjepan Glavina-41/+0
2017-11-22Auto merge of #44781 - QuietMisdreavus:doc-include, r=GuillaumeGomezbors-0/+40
rustdoc: include external files in documentation (RFC 1990) Part of https://github.com/rust-lang/rfcs/pull/1990 (needs work on the error reporting, which i'm deferring to after this initial PR) cc #44732 Also fixes #42760, because the prep work for the error reporting made it easy to fix that at the same time.
2017-11-22Stabilize spin_loop_hintStjepan Glavina-4/+4
2017-11-21allow loading external files in documentationQuietMisdreavus-0/+40
Partial implementation of https://github.com/rust-lang/rfcs/pull/1990 (needs error reporting work) cc #44732
2017-11-21fix some typosMartin Lindhe-5/+5
2017-11-21Auto merge of #45039 - QuietMisdreavus:doc-spotlight, ↵bors-0/+30
r=GuillaumeGomez,QuietMisdreavus show in docs whether the return type of a function impls Iterator/Read/Write Closes #25928 This PR makes it so that when rustdoc documents a function, it checks the return type to see whether it implements a handful of specific traits. If so, it will print the impl and any associated types. Rather than doing this via a whitelist within rustdoc, i chose to do this by a new `#[doc]` attribute parameter, so things like `Future` could tap into this if desired. ### Known shortcomings ~~The printing of impls currently uses the `where` class over the whole thing to shrink the font size relative to the function definition itself. Naturally, when the impl has a where clause of its own, it gets shrunken even further:~~ (This is no longer a problem because the design changed and rendered this concern moot.) The lookup currently just looks at the top-level type, not looking inside things like Result or Option, which renders the spotlights on Read/Write a little less useful: <details><summary>`File::{open, create}` don't have spotlight info (pic of old design)</summary> ![image](https://user-images.githubusercontent.com/5217170/31209495-e59d027e-a950-11e7-9998-ceefceb71c07.png) </details> All three of the initially spotlighted traits are generically implemented on `&mut` references. Rustdoc currently treats a `&mut T` reference-to-a-generic as an impl on the reference primitive itself. `&mut Self` counts as a generic in the eyes of rustdoc. All this combines to create this lovely scene on `Iterator::by_ref`: <details><summary>`Iterator::by_ref` spotlights Iterator, Read, and Write (pic of old design)</summary> ![image](https://user-images.githubusercontent.com/5217170/31209554-50b271ca-a951-11e7-928b-4f83416c8681.png) </details>
2017-11-20Update books for next releasesteveklabnik-0/+0
Also includes a fix in std::ops
2017-11-18Rollup merge of #45767 - QuietMisdreavus:who-docs-the-doc-tool, r=frewsxcvGuillaume Gomez-6/+28
rustdoc book: talk about #![doc(test(no_crate_inject))] and #![doc(test(attr(...)))] While investigating https://github.com/rust-lang/rust/issues/45750 i noticed that `#![doc(test(attr(...)))]` wasn't documented at all. Since this is useful for making your examples follow the same coding guidelines as your code, i wanted to add it to the Rustdoc Book. I also added `#![doc(test(no_crate_inject))]` since it's used in the same place and might be useful for macro-heavy crates. I added mentions for these to "The `doc` attribute" as well as "Documentation tests" since it's useful information in both places. Technically the step reordering in the second commit is gated on https://github.com/rust-lang/rust/pull/45764, since before that lands attributes from the doctest come before the ones from `#![doc(test(attr(...)))]`.
2017-11-17update links and tracking issue for doc_spotlightQuietMisdreavus-2/+5
2017-11-17add doc_highlight feature flag and testsQuietMisdreavus-0/+27
2017-11-16Auto merge of #45692 - steveklabnik:ship-cargo-book, r=alexcrichtonbors-0/+2
Start shipping the Cargo book Fixes #44910 Fixes #39588 See both of those bugs for more details.
2017-11-15Add universal_impl_trait unstable-book entryChristopher Vittal-0/+32
2017-11-14link the cargo book into the bookshelfsteveklabnik-0/+2
2017-11-08std: Remove `rand` crate and moduleAlex Crichton-5/+0
This commit removes the `rand` crate from the standard library facade as well as the `__rand` module in the standard library. Neither of these were used in any meaningful way in the standard library itself. The only need for randomness in libstd is to initialize the thread-local keys of a `HashMap`, and that unconditionally used `OsRng` defined in the standard library anyway. The cruft of the `rand` crate and the extra `rand` support in the standard library makes libstd slightly more difficult to port to new platforms, namely WebAssembly which doesn't have any randomness at all (without interfacing with JS). The purpose of this commit is to clarify and streamline randomness in libstd, focusing on how it's only required in one location, hashmap seeds. Note that the `rand` crate out of tree has almost always been a drop-in replacement for the `rand` crate in-tree, so any usage (accidental or purposeful) of the crate in-tree should switch to the `rand` crate on crates.io. This then also has the further benefit of avoiding duplication (mostly) between the two crates!
2017-11-04Update reference link in doc's 404Ryan Scheel-1/+1
It's currently linking to a page that says it's on the page I'm changing the link too.
2017-11-04rustdoc book: talk about #![doc(test(...))] in doctests chapterQuietMisdreavus-6/+8