about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2016-05-26Implement `..` in tuple (struct) patternsVadim Petrochenkov-0/+2
2016-05-24Rollup merge of #33810 - tmr232:patch-1, r=ManishearthGuillaume Gomez-1/+1
Fixed link in Rust Book (no-stdlib) Closes #33806
2016-05-24Rollup merge of #33759 - aakloxu:patch-2, r=steveklabnikGuillaume Gomez-2/+0
Fix references links There are duplicate link references in the article and just remove one of them.
2016-05-23Fixed link in Rust Book (no-stdlib)Tamir Bahar-1/+1
Fix a broken link in the rust book.
2016-05-21src/doc: Keep the original style of linksAaklo Xu-2/+2
2016-05-21Rollup merge of #33750 - alx741:fix_typo, r=ManishearthManish Goregaokar-1/+1
book: ownership: fix typo The sentence ends there, so a comma is required. See: http://english.stackexchange.com/questions/1469/when-ending-a-list-with-etc-should-there-be-a-comma-before-etc
2016-05-21Rollup merge of #33747 - postmodern:patch-2, r=ManishearthManish Goregaokar-4/+5
Clarify the English translation of `?Sized` * It wasn't clear whether `?Sized` meant "not `Sized`" or "`Sized` or not `Sized`". According to #rust IRC, it does indeed mean "`Sized` or not `Sized`". * Use the same language as [Trait std::marker::Sized](https://doc.rust-lang.org/std/marker/trait.Sized.html) about how `Sized` is implicitly bound. * Refer to the syntax as `?Sized`, since it's currently the only allowed trait that can follow `?`.
2016-05-21Rollup merge of #33743 - royalstream:royalstream-stack-doc, r=steveklabnikManish Goregaokar-2/+2
Book: small improvement to a table to make it clearer This table is used as an example of four heap values where two of them got deallocated leaving a gap. It also has stack variables. Instead of four stack variables I propose three, that way there's no misleading connection between the number of stack variables and heap variables. But more importantly: three of the four stack variables had the same name (**y**) which could be confusing to a beginner, I changed this as well.
2016-05-20Wording changesPostmodern-3/+3
* Use "special bound syntax" instead of "special syntax". `?Sized` is technically a "bound", but `?Sized` is specialized syntax that _only_ works with `Sized`, and no other Trait. * Replace "constant size" with "sized".
2016-05-20Fix references linksAaklo Xu-4/+2
There are Duplicate link references in the article and the format is incorrect.
2016-05-20Rollup merge of #33745 - postmodern:patch-1, r=steveklabnikGuillaume Gomez-2/+2
Clarify wording in `transmute` example * Change "four eights" to "four u8s" * Change "a 32" to "a u32"
2016-05-19book: ownership: fix typoDaniel Campoverde [alx741]-1/+1
2016-05-19Grammar changePostmodern-3/+4
2016-05-19Keep line-width within 80 columnsPostmodern-2/+3
2016-05-19Clarify the English translation of `?Sized`Postmodern-4/+3
* It wasn't clear whether `?Sized` meant "not `Sized`" or "`Sized` or not `Sized`". According to #rust IRC, it does indeed mean "`Sized` or not `Sized`". * Use the same language as [Trait std::marker::Sized](https://doc.rust-lang.org/std/marker/trait.Sized.html) about how `Sized` is implicitly bound.
2016-05-19Clarify wording in `transmute` examplePostmodern-2/+2
* Change "four eights" to "four u8s" * Change "a 32" to "a u32"
2016-05-19Book: small improvement to a table to make it clearerSteven Burns-2/+2
2016-05-19Rollup merge of #33721 - royalstream:royalstream-doc-highlights, r=ManishearthManish Goregaokar-38/+38
Rust syntax coloring for some ignore, should-panic and no-run snippets. In the book, some code blocks were missing the `rust` specifier which is needed for them to highlight correctly.
2016-05-19Rollup merge of #33720 - mark-summerfield:patch-1, r=steveklabnikManish Goregaokar-0/+2
Clarified that `let(mut x, y) =` only makes x mutable, not y Closes #33716
2016-05-19Rollup merge of #33611 - vvanders:master, r=steveklabnikManish Goregaokar-0/+47
Add a note about Higher-Ranked Trait Bounds in docs on Closures. I hit a snag with lifetimes a few days ago and it wasn't until @birkenfeld pointed out Higher-Ranked Trait Bounds that I was able to solve the issue involving lifetimes on closure traits. This adds a small section in the book so that other users can find it. r? @steveklabnik
2016-05-18Rust syntax coloring for some ignore, should-panic and no-run snippets.Steven Burns-38/+38
2016-05-18Clarified that `let(mut x, y) =` only makes x mutable, not ymark-summerfield-0/+2
2016-05-15Update link to licenseFlorian Berger-1/+1
2016-05-13Updated based on CR feedback.Val Vanderschaegen-3/+3
2016-05-12Add a note about Higher-Ranked Trait Bounds in docs on Closures.Val Vanderschaegen-0/+47
When using closures that take references with explicit lifetimes sometimes it's required to use where F: for<..> ... syntax to express the right lifetimes. This adds a quick note to the docs so other users can discover it as well.
2016-05-11Rollup merge of #33558 - bnewbold:trivial-book-tweaks, r=steveklabnikGuillaume Gomez-5/+5
trivial tweaks to documentation (book) These are small things I found while reading through The Book. The `<hash>` and `panic!` lines are simply to improve readability, while I believe the proceeding/following distinction is a bug (but might be a English dialect distinction?). I've read `rust/CONTRIBUTING`, i'm not sure if there is anything I need to do other than submit this PR. r? @steveklabnik
2016-05-11trivial fixes to documentation (book)bnewbold-5/+5
2016-05-11Rollup merge of #33524 - briangreenery:briangreenery-fast-and-loose, ↵Steve Klabnik-1/+1
r=steveklabnik doc: Fix tiny typo in vec-alloc.md Change `fast an loose` to `fast and loose`.
2016-05-10Auto merge of #33512 - birkenfeld:issue-25944, r=sanxiynbors-1/+1
rustdoc: remove artificial indentation of doctest code The indentation makes the examples look nicer when printed (when is this done?), but breaks tests using multi-line string literals. Fixes: #25944
2016-05-09Rollup merge of #33480 - birkenfeld:issue-33422, r=steveklabnikManish Goregaokar-59/+61
book: fixup code in error handling tutorial A few oversights happened while porting the example from docopt to getopts. I retraced all the steps, fixing code and description as necessary. Fixes: #33422
2016-05-09doc: Fix tiny typo in vec-alloc.mdBrian Green-1/+1
Change `fast an loose` to `fast and loose`.
2016-05-09rustdoc: remove artificial indentation of doctest codeGeorg Brandl-1/+1
This makes the examples look nicer when printed (when is this done?), but breaks tests using multi-line string literals. Fixes: #25944
2016-05-09Add #[cfg(target_has_atomic)] to get atomic support for the current targetAmanieu d'Antras-0/+5
2016-05-08Auto merge of #33414 - Nercury:master, r=alexcrichtonbors-0/+1
Add armv7-linux-androideabi target This PR adds `armv7-linux-androideabi` target that matches `armeabi-v7a` Android ABI, ~~downscales `arm-linux-androideabi` target to match `armeabi` Android ABI~~ (TBD later if needed). This should allow us to get the best performance from every [Android ABI level](http://developer.android.com/ndk/guides/abis.html). Currently existing target `arm-linux-androideabi` started gaining features out of the supported range of [android `armeabi`](http://developer.android.com/ndk/guides/abis.html). While android compiler does not use a different target for later supported `armv7` architecture, it has distinct ABI name `armeabi-v7a`. We decided to add rust target `armv7-linux-androideabi` to match it. Note that `NEON`, `VFPv3-D32`, and `ThumbEE` instruction sets are not added, because not all android devices are guaranteed to support all or some of these, and [their availability should be checked at runtime](http://developer.android.com/ndk/guides/abis.html#v7a). ~~This reduces performance of existing `arm-linux-androideabi` and may make it _much_ slower (we are talking more than order of magnitude in some random ad-hoc fp benchmark that I did).~~ Part of #33278.
2016-05-07Add armv7-linux-androideabi target.Nerijus Arlauskas-0/+1
2016-05-07book: fixup code in error handling tutorialGeorg Brandl-59/+61
A few oversights happened while porting the example from docopt to getopts. I retraced all the steps, fixing code and description as necessary. Fixes: #33422
2016-05-05doc: Update reference with better description of target_envBrian Anderson-18/+26
The definition of this value recently changed slightly. It no longer corresponds directly to the target triple. Also shuffled things around to make the order of cfg descriptions more logical and added text related them to the target triple. cc #33403
2016-05-01doc/book/getting-started.md: Removed references to creating a new executable ↵Stephen Mather-3/+3
from 'Converting to Cargo'.
2016-05-01doc/book/getting-started.md: Corrected spelling of 'Internet'.Stephen Mather-1/+1
2016-04-29Rollup merge of #33253 - ergenekonyigit:master, r=alexcrichtonManish Goregaokar-3/+21
rustdoc: fixed some RFCs r? @alexcrichton
2016-04-28Rollup merge of #33234 - TomasHubelbauer:TomasHubelbauer-patch-1, ↵Steve Klabnik-1/+1
r=GuillaumeGomez Fix use of the `move` command in the Windows shell `move` works both in `cmd` and in Powershell. `mv` works only in Powershell and the book says nothing about which shell is recommended so this could confuse beginners. Closes #33219.
2016-04-28Rollup merge of #33095 - xogeny:xogeny-patch-1, r=steveklabnikSteve Klabnik-6/+6
Tweaks to sections related to Ownership Reading through these sections, I thought the intro text could be improved slightly. So here is a PR that addresses what was bugging me about it. :-) Main issue was the wording of the opening sentence ("guide" is not clearly defined and the wording was a bit too terse in my opinion). I also took issue with the term "one of the most unique". Uniqueness is a `bool`, not an `f64`. :-) r? @steveklabnik
2016-04-28Rollup merge of #32991 - kindlychung:patch-2, r=steveklabnikSteve Klabnik-0/+26
make the borrowing example more concrete
2016-04-28update features RFCErgenekon Yigit-1/+1
2016-04-28update comments RFC and code snippetsErgenekon Yigit-2/+20
2016-04-27Fix use of the `move` command in the Windows shellTomáš Hübelbauer-1/+1
`move` work both in `cmd` and in Powershell. `mv` works only in Powershell and the book says nothing about which shell is recommended so this could confuse beginners. Closes #33219.
2016-04-26Update references-and-borrowing.mdKaiyin Zhong-0/+18
add as 2nd example.
2016-04-24Auto merge of #33120 - tclfs:patch-2, r=Manishearthbors-1/+1
docs: Highlight a keyword
2016-04-24Auto merge of #33163 - c4rlo:patch-2, r=Manishearthbors-1/+1
subtyping.md: typo fix
2016-04-23Auto merge of #33092 - alexcrichton:rustbuild-docs, r=brsonbors-82/+82
rustbuild: Run all markdown documentation tests This commit adds support to rustbuild to run all documentation tests, basically running `rustdoc --test` over all our documentation.