about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2016-10-18Fix some mistakes in HRTB docsMatt Brubeck-9/+10
The example code for higher-ranked trait bounds on closures had an unnecessary `mut` which was confusing, and the text referred to an mutable reference which does not exist in the code (and isn't needed). Removed the `mut`s and fixed the text to better describe the actual error for the failing example.
2016-10-17Rollup merge of #37194 - johnthagen:fix-const-static-header, r=blussGuillaume Gomez-1/+1
Remove un-rendered ticks from "const and static" doc title Related to #37116 and #37119. Ticks in the titles are not correctly rendered ![const-static-render](https://cloud.githubusercontent.com/assets/10340167/19412643/63e385a2-92e8-11e6-81f1-16802f803aad.png)
2016-10-17Fix a error of 'book/deref-coercions.html'loggerhead-1/+1
The original sentence is: > This example has two conversions: `Rc<String>` to `String` and then `String` to `&str`. But it should be > This example has two conversions: `Rc<String>` to `String` and then `String` to `str`. or > This example has two conversions: `&Rc<String>` to `&String` and then `&String` to `&str`. I think the latter is more clearly.
2016-10-15Remove un-rendered ticks from title.johnthagen-1/+1
2016-10-15rustdoc: Improve playground run buttonsOliver Middleton-4/+5
The main change is to stop using javascript to generate the URLs and use rustdoc instead. This also adds run buttons to the error index examples.
2016-10-14Rollup merge of #37119 - durka:patch-31, r=steveklabnikJonathan Turner-1/+1
book: remove backticks in Type Aliases header Fix #37116.
2016-10-14Rollup merge of #36755 - Rantanen:master, r=GuillaumeGomezJonathan Turner-14/+76
Explain motivation behind lifetimes Start the lifetime section with an explanation of the issues that lack of explicit lifetimes cause and how the explicit lifetimes solve these. ---------------- I had really hard time figuring out why I would need to care about the explicit reference lifetimes when going through the book at first. With strong background in C++, I'm familiar with the dangling reference problem - but given the section seems to focus more on the lifetime syntax and various ways to define lifetimes on functions and structs, I was unable to understand how they are used to solve the reference problem. This PR is an attempt at getting the reader to understand what the explicit lifetimes are used for and why they are an awesome thing instead of a bit of syntax that just has to be written. It's been less than a week that I've been diving into Rust so I'm far from certain about the terminology and technical correctness. I tried mimicking the existing terminology from the lifetimes section, but still no promises on getting it right.
2016-10-13Explain motivation behind lifetimesMikko Rantanen-14/+76
Start the lifetime section with an explanation of the issues that lack of explicit lifetimes cause and how lifetimes alleviate these.
2016-10-12Rollup merge of #36995 - nrc:stable, r=@nikomatsakisAlex Crichton-2/+1
stabilise ?, attributes on stmts, deprecate Reflect r? @nikomatsakis
2016-10-12book: remove backticks in Type Aliases headerAlex Burka-1/+1
Fix #37116.
2016-10-12Stabilise attributes on statements.Nick Cameron-2/+1
Note that attributes on expressions are still unstable and are behind the `stmt_expr_attributes` flag. cc [Tracking issue](https://github.com/rust-lang/rust/issues/15701)
2016-10-11Rollup merge of #36997 - KillTheMule:patch-1, r=steveklabnikGuillaume Gomez-2/+6
Book: Be very explicit of lifetimes being descriptive ... not prescriptive. Pointed out in https://users.rust-lang.org/t/what-if-i-get-lifetimes-wrong/7535/4, which was a revelation to me and made me think this should be more clear in the book. I'm not sure if I got this entirely right or if the wording is good, but I figured a PR is more helpful than a simple issue. r? @steveklabnik Small Note: There's also https://github.com/rust-lang/book, should I have sent the PR there? It doesn't coincide with the online book though, so I figured it's better of here.
2016-10-07Rollup merge of #37008 - tshepang:quotes, r=steveklabnikGuillaume Gomez-3/+3
reference: use ticks instead of quotes
2016-10-07Rollup merge of #36929 - angelsl:issue-36683, r=steveklabnikGuillaume Gomez-2/+7
Reference: Mention `move` keyword for lambdas From issue #36683
2016-10-07Wrap & improveKillTheMule-4/+6
2016-10-06reference: use ticks instead of quotesTshepang Lekhonkhobe-3/+3
2016-10-06Rollup merge of #36957 - cynicaldevil:docs, r=frewsxcvJonathan Turner-3/+3
Minor modifications in concurrency section of the Rust book Fixes #36939 r? @steveklabnik
2016-10-06TyposKillTheMule-1/+1
2016-10-06Another shot at clarityKillTheMule-1/+1
2016-10-06Distinguish lifetimes and their annotationsKillTheMule-1/+1
Also, emphasize differently.
2016-10-06Book: Be very explicit of lifetimes being descriptiveKillTheMule-0/+2
... no prescriptive. Pointed out in https://users.rust-lang.org/t/what-if-i-get-lifetimes-wrong/7535/4, which was a revelation to me and made me think this should be more clear in the book.
2016-10-04Minor modifications in concurrency section of the Rust bookNikhil Shagrithaya-3/+3
2016-10-05reference: mention `move` keyword for lambdasangelsl-2/+7
2016-10-02Avoid introducing `run` twicePhilip Davis-6/+6
As it stands, getting-started and guessing-game both introduce `run` as a new command. The second should probably make it clear that the reader has seen it before :)
2016-09-30Rollup merge of #36860 - wesleywiser:patch-2, r=ManishearthSteve Klabnik-0/+10
Add `Send` and `Sync` traits to the reference Fixes #36859
2016-09-30Rollup merge of #36711 - pcn:patch-1, r=steveklabnikSteve Klabnik-1/+1
Suggesting a change to a comment that puzzled me While reading this, the comment made it difficult for me to simply absorb the concept. It interrupted my reading flow, and I think this expresses the same meaning, but reads a bit better. It's trivial, but makes it easier for me to move on to the next line.
2016-09-30Add `Send` and `Sync` traits to the referenceWesley Wiser-0/+10
Fixes #36859
2016-09-28Rollup merge of #35286 - dns2utf8:doc_never_expression, r=nikomatsakisJonathan Turner-1/+11
Add docs for "!" Never type (rfc 1216) Pull Request: https://github.com/rust-lang/rfcs/pull/1216 Tracking Issue: #35121
2016-09-28Rollup merge of #36769 - nathanmusoke:master, r=apasel422Jonathan Turner-1/+1
doc: Fix minor typo in book/variable-bindings.md r? @steveklabnik
2016-09-27Improve documention troubleshooting missing linker. Fix #32208.Paulo Matos-6/+16
2016-09-27doc: Fix minor typo in book/variable-bindings.mdNathan Musoke-1/+1
2016-09-26Use "through"Peter N-1/+1
2016-09-26Rollup merge of #36563 - vanjacosic:patch-1, r=steveklabnikJonathan Turner-5/+6
Docs: Update to "Getting Started" section I came across #34523 and wanted to suggest a solution. See commit for details. It seemed like a good place to start contributing, let me know if I did anything wrong 😇
2016-09-26Remove whitespace from line endingsVanja Cosic-4/+4
2016-09-25Auto merge of #36564 - vanjacosic:patch-2, r=GuillaumeGomezbors-2/+2
Docs: Update to "Ownership" section Found #34865 while looking for easy docs wins I could contribute with.
2016-09-25Suggesting a change to a comment that puzzled mePeter N-1/+1
While reading this, the comment made it difficult for me to simply absorb the concept. It interrupted my reading flow, and I think this expresses the same meaning, but reads a bit better.
2016-09-18Updated "Ownership". Trying to fix #34865Vanja Cosic-2/+2
- Reword - Add link
2016-09-18Updated "Getting started". Trying to fix #34523Vanja Cosic-5/+6
- Updated paragraphs and wording for clarity. - Renamed `helloworld.rs` to `myprogram.rs` to make it clearer that it's an unrelated example.
2016-09-17Browsers do not consistently handle non-integer values for font-size.Eitan Adler-1/+1
2016-09-14Don't ignore a doc code-block we can compile.Corey Farwell-1/+1
2016-09-14Rollup merge of #36374 - dangcheng:patch-1, r=steveklabnikGuillaume Gomez-2/+2
book: fix mistake (File::open -> File::create)
2016-09-13Rollup merge of #36380 - kylog:fix-typo, r=steveklabnikGuillaume Gomez-1/+1
book: fix a typo
2016-09-12change error messagedangcheng-2/+2
2016-09-10book: fix a typoKylo Ginsberg-1/+1
2016-09-10Rollup merge of #36326 - JDemler:master, r=steveklabnikGuillaume Gomez-1/+1
Fixed typo in nomicon
2016-09-10fix mistake (File::open -> File::create)dangcheng-2/+2
2016-09-09Auto merge of #36332 - llogiq:static_consts_feature, r=nikomatsakisbors-0/+3
add static_in_const feature gate also updates tests and deletes the spurious .bk files I inadvertently added last time. r? @nikomatsakis
2016-09-09Issue deprecation warnings for safe accesses to extern staticsVadim Petrochenkov-1/+1
2016-09-08added feature description to referenceAndre Bogus-0/+3
2016-09-07Fixed typo in nomiconJakob Demler-1/+1