about summary refs log tree commit diff
path: root/src/doc/guide.md
AgeCommit message (Collapse)AuthorLines
2014-12-24doc: remove repeated infoTshepang Lekhonkhobe-4/+0
2014-12-22rollup merge of #20102: tshepang/patch-4Alex Crichton-2/+2
That sentence made it look like there was no option for using 'mut'
2014-12-21Fallout of std::str stabilizationAlex Crichton-12/+12
2014-12-21rollup merge of #19957: tshepang/patch-1Alex Crichton-1/+0
2014-12-21rollup merge of #19823: iKevinY/doc-fixesAlex Crichton-78/+76
I was reading through the Rust Guide (hopefully looking to learn some Rust), and I figured it would be a good idea to open a pull request with some of the errata I noticed along the way. Most of the changes are pretty mundane, but there are a couple that might raise a bit of discussion. ### Punctuation outside of 'key term' quotes This is something that was inconsistent in the Guide. While the convention in American English is to place punctuation immediately following a quotation mark *inside* the quotation mark, it seems strange to do this with 'key terms', considering they are not a true quotation. ### Changed comment placement in 17.2 code block This is what the code block in [17.2 — Ownership, borrowing, and lifetimes](http://doc.rust-lang.org/guide.html#ownership,-borrowing,-and-lifetimes) looks like in fullscreened Safari 8: ![screen shot 2014-12-13 at 2 48 47 pm](https://cloud.githubusercontent.com/assets/2434728/5425704/2fff3bf0-82d7-11e4-8c8f-d594acde8937.png) Some of the comments extend *just* too far, causing them to bleed into the next line, so I moved a few of them above the relevant lines of code to avoid this.
2014-12-21doc: add missing "by default"Tshepang Lekhonkhobe-2/+2
That sentence made it look like there was no option for using 'mut'
2014-12-19Miscellaneous changes to Rust GuideKevin Yap-78/+76
- Various grammatical changes - Place punctuation outside of key term quotes - Change comment placement in 17.2 code block - Replace double hyphens with en dashes
2014-12-18Revise std::thread API to join by defaultAaron Turon-5/+7
This commit is part of a series that introduces a `std::thread` API to replace `std::task`. In the new API, `spawn` returns a `JoinGuard`, which by default will join the spawned thread when dropped. It can also be used to join explicitly at any time, returning the thread's result. Alternatively, the spawned thread can be explicitly detached (so no join takes place). As part of this change, Rust processes now terminate when the main thread exits, even if other detached threads are still running, moving Rust closer to standard threading models. This new behavior may break code that was relying on the previously implicit join-all. In addition to the above, the new thread API also offers some built-in support for building blocking abstractions in user space; see the module doc for details. Closes #18000 [breaking-change]
2014-12-18doc: mailing list is deprecatedTshepang Lekhonkhobe-1/+1
2014-12-17rollup merge of #19930: cllns/lowercase-ifAlex Crichton-1/+1
On the [guide site](http://doc.rust-lang.org/guide.html#if) I was confused when I got to "5 If". It looked like "5 LF" in lowercase. Changing the if to lowercase solves this problem. I know titles are all capitalized, but I think it makes sense in this case to keep it lowercase, since `if` is a reserved word. I'd also be open to making it ``` `if` ``` but I'm not sure how that would look on the site. Before: ![screen shot 2014-12-16 at 12 58 01](https://cloud.githubusercontent.com/assets/632942/5458866/cb34c006-8523-11e4-89ef-3a3964bcedfc.png) After: ![screen shot 2014-12-16 at 12 58 14](https://cloud.githubusercontent.com/assets/632942/5458865/cb33c444-8523-11e4-8d95-d377ed583ed6.png)
2014-12-17rollup merge of #19873: drewm1980/masterAlex Crichton-1/+1
In US english, "that" is used in restrictive clauses in place of "which", and often affects the meaning of sentences. In UK english and many dialects, no distinction is made. While Rust devs want to avoid unproductive pedanticism, it is worth at least being uniform in documentation such as: http://doc.rust-lang.org/std/iter/index.html and also in cases where correct usage of US english clarifies the sentence.
2014-12-17rollup merge of #19743: steveklabnik/gh16143Alex Crichton-26/+46
This will hopefully help people with their first steps in Rust. Fixes #16143. /cc @jvns
2014-12-17doc: remove extraneous lineTshepang Lekhonkhobe-1/+0
2014-12-16Change 'if' to lowercase, so it displays better on the siteSean Collins-1/+1
2014-12-15auto merge of #19882 : steveklabnik/rust/fix_download, r=nikomatsakisbors-2/+3
Thank you, @Ap0ph1s.
2014-12-15Fix windows download linksSteve Klabnik-2/+3
Thank you, @Ap0ph1s.
2014-12-15rollup merge of #19714: steveklabnik/gh16219Brian Anderson-56/+56
These should be properly annotated instead. Fixes #16219.
2014-12-15Standardize some usages of "which" in docstringsAndrew Wagner-1/+1
In US english, "that" is used in restrictive clauses in place of "which", and often affects the meaning of sentences. In UK english and many dialects, no distinction is made. While Rust devs want to avoid unproductive pedanticism, it is worth at least being uniform in documentation such as: http://doc.rust-lang.org/std/iter/index.html and also in cases where correct usage of US english clarifies the sentence.
2014-12-14Update guide/intro to take into account the removal of `proc`.Niko Matsakis-51/+34
cc @steveklabnick
2014-12-11Add comments with type annotations.Steve Klabnik-26/+46
This will hopefully help people with their first steps in Rust. Fixes #16143.
2014-12-10Fix up some {ignore} and {notrust}sSteve Klabnik-56/+56
These should be properly annotated instead. Fixes #16219.
2014-12-09Test fixes and rebase conflicts from the rollupAlex Crichton-35/+35
2014-12-09rollup merge of #19616: steveklabnik/gh19556Alex Crichton-0/+49
Closes #19556.
2014-12-09rollup merge of #19614: steveklabnik/gh19599Alex Crichton-51/+51
Fixes #19599
2014-12-09rollup merge of #19576: nhoss2/masterAlex Crichton-2/+2
There was a link to a non existing guide
2014-12-07Add enum namespacing to the Guide.Steve Klabnik-0/+49
Closes #19556.
2014-12-07remove usage of notrust from the docsSteve Klabnik-51/+51
Fixes #19599
2014-12-06fix 404Nafis-2/+2
2014-12-05rollup merge of #19526: steveklabnik/gh19402Corey Richardson-6/+6
Fixes #19402.
2014-12-05rollup merge of #19525: steveklabnik/guide_editsCorey Richardson-5/+5
Fixes #19335. (or at least, the actionable parts)
2014-12-05rollup merge of #19462: MatejLach/but-and_guideCorey Richardson-1/+1
Using `and` here instead of `but` sounds better to me, as but makes it sound like an item which is still under active development shouldn't normally require more testing, but this one does - or something like that :-) @steveklabnik?
2014-12-04Tasks aren't actually lightweight :frown:Steve Klabnik-6/+6
Fixes #19402.
2014-12-04Some small copy edits to the guide.Steve Klabnik-5/+5
Fixes #19335.
2014-12-02replace 'but' with 'and'Matej Lach-1/+1
2014-12-02better wordingMatej Lach-2/+2
2014-11-29Fix a simple typoMatej Lach-1/+1
2014-11-26rollup merge of #19336: apasel422/guideAlex Crichton-8/+8
- `s/(left|right) hand/\1-hand/` - `s/parenthesis/parentheses/` - `s/unicode/Unicode/` - `s/validly-encoded/validly encoded/`
2014-11-26rollup merge of #19313: steveklabnik/gh18844Alex Crichton-1/+1
Fixes #18844
2014-11-26rollup merge of #19312: steveklabnik/gh19177Alex Crichton-1/+14
2014-11-26rollup merge of #19310: steveklabnik/gh19178Alex Crichton-0/+16
Fixes #19178
2014-11-26fix errors in the guideAndrew Paseltiner-8/+8
- `s/(left|right) hand/\1-hand/` - `s/parenthesis/parentheses/` - `s/unicode/Unicode/` - `s/validly-encoded/validly encoded/`
2014-11-25We now support 64 bit Windows.Steve Klabnik-1/+1
Fixes #18844
2014-11-25add slice patterns to the guideSteve Klabnik-0/+13
Fixes #19177.
2014-11-25Extra note about struct matching orderSteve Klabnik-0/+16
Fixes #19178
2014-11-25Make note that examples need a main()Steve Klabnik-1/+7
Fixes #19199
2014-11-23auto merge of #18140 : JelteF/rust-1/guide-fix, r=cmrbors-2/+2
The reason given didn't make any sense when I read it when reading through the docs. I think this is more clear. Please let me know it is also more correct.
2014-11-23Fix the reason for calling a file lib.rsJelte Fennema-2/+2
2014-11-19rollup merge of #18968: danluu/guide_playJakub Bukaj-0/+2
As-is, there's no indication that the code examples pop out into a window that runs on `play.rust-lang.org` until you mouse over them. I managed to get to section 4 of the guide before realizing you could do this since it didn't occur to me to mouse over the example text. cc @rose since we went through the tutorial together and I think it wasn't obvious to her either.
2014-11-17Switch to purely namespaced enumsSteven Fackler-20/+20
This breaks code that referred to variant names in the same namespace as their enum. Reexport the variants in the old location or alter code to refer to the new locations: ``` pub enum Foo { A, B } fn main() { let a = A; } ``` => ``` pub use self::Foo::{A, B}; pub enum Foo { A, B } fn main() { let a = A; } ``` or ``` pub enum Foo { A, B } fn main() { let a = Foo::A; } ``` [breaking-change]
2014-11-14Guide: add a pointer to play.rust-lang.org and explain how to run the code ↵Dan Luu-0/+2
examples.