summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2015-10-27Auto merge of #29326 - Charlotteis:patch-1, r=steveklabnikbors-4/+4
The beginning of the work that needs to be done as part of #28835. :sunny:
2015-10-27Auto merge of #29317 - matklad:clarify-reference, r=steveklabnikbors-5/+5
Rust reference is a bit confusing here, because it does not explicitly mention trait objects. See an example of confusion here https://users.rust-lang.org/t/confusion-about-impls-without-for/3379/2 :) r? @steveklabnik
2015-10-27Auto merge of #29309 - rjbs:doc-comment-sections, r=alexcrichtonbors-37/+35
As displayed before this commit, I found the book confusing in its explanation of `#`-led comments in `rust` blocks. Possibly the biggest confusion was because the many-dashes construct does not become an HR element in the Markdown translator used, so things were not being properly set off. This change should more clearly show the as-rendered content as rendered, and the as-coded content as code.
2015-10-26Remove use of 'just' in trpl/installing-rust.mdCharlotte Spencer-4/+4
The beginning of the work that needs to be done as part of #28835.
2015-10-26Auto merge of #29310 - mdinger:book_playpen, r=steveklabnikbors-6/+9
Makes rustbook code playpen links follow the style set in https://github.com/rust-lang/rust/pull/28963. This is basically cut and paste from the other one. The link looks better and still works so I assume it's good. ![rustbook](https://cloud.githubusercontent.com/assets/4156987/10717631/7a74f8ae-7b34-11e5-8870-35b5fc2526a4.png) Fixes https://github.com/rust-lang/rust/issues/29308 r? @steveklabnik
2015-10-26Auto merge of #29280 - Ryman:bad_docattr, r=Manishearthbors-1/+1
As is, this attr would lead to the "///" prefix being in the output text.
2015-10-26Auto merge of #29247 - dcarral:missing_word_trpl, r=steveklabnikbors-1/+1
I somehow missed a word behind the numbers while going through this section, don't know what the best approach would be though since "**available** addresses" sounds good to me, too".
2015-10-26reference: clarify implAleksey Kladov-5/+5
Another kind of nominal types in Rust are trait objects, so the following is valid ```rust trait A { } impl A { } ```
2015-10-25Update the playpen link for code in the rust book to agree with rustdoc's ↵mdinger-6/+9
new style
2015-10-25reformat the docs for hidden code in rust sectionsRicardo Signes-37/+35
As displayed before this commit, I found the book confusing in its explanation of `#`-led comments in `rust` blocks. Possibly the biggest confusion was because the many-dashes construct does not become an HR element in the Markdown translator used, so things were not being properly set off. This change should more clearly show the as-rendered content as rendered, and the as-coded content as code.
2015-10-24Fix docattr to match surrounding textKevin Butler-1/+1
As is, this attr would lead to the "///" prefix being in the output text
2015-10-24Auto merge of #29215 - fhahn:issue-28157-bad-semicolon, r=alexcrichtonbors-1/+1
PR for #28157. At the moment, `rustc` emits a warning when a bare semicolon is encountered (could also be a fail, but I think this is a backwards incompatible change). Also I am not sure where the best place for a test for that warning would be. Seems run-pass tests do not check warnings.
2015-10-24Allow bare semicolon in grammar doc, closes #28157Florian Hahn-1/+1
2015-10-23Add missing word to TRPL's 'The Heap' sectionDaniel Carral-1/+1
2015-10-23Auto merge of #29194 - chrisccerami:clarify-headers-in-traits-docs, ↵bors-6/+16
r=Manishearth It's possible that there is some meaning I'm not grasping from the headers "Traits bounds for generic functions" and "Traits bounds for generic structs", but they seem to me like they could be clearer and more grammatically correct.
2015-10-23Define bounds in glossary.mdChris C Cerami-6/+16
2015-10-22Rollup merge of #29230 - tsion:fix-nomicon-typo-2, r=steveklabnikSteve Klabnik-5/+5
r? @steveklabnik
2015-10-22Rollup merge of #29207 - ykomatsu:trpl, r=steveklabnikSteve Klabnik-3/+3
2015-10-22Rollup merge of #29193 - kini:filename-conventions, r=alexcrichtonSteve Klabnik-2/+3
When reading this paragraph, the beginning Rust programmer is starting to write a Hello World program. We have just told her to name the file `main.rs`, and immediately afterward, a `hello_world.rs` is mentioned. I changed this to an unrelated filename (incidentally one that appears in this repository) to make it clear that this is just an example. Also, wording it as a declarative sentence rather than an imperative one further separates it from the Hello World instructions in this section. r? @steveklabnik (Let me know if I'm sending too many PRs -- I can batch up TRPL edits, say, per chapter, if that works better. Or I can just refrain from editing TRPL as I read through it, if these are not sufficiently useful.)
2015-10-22Rollup merge of #29170 - kini:curl-sh-disclaimer, r=steveklabnikSteve Klabnik-5/+9
The paragraph here seemed confusing, so I reworded it. Also added another possible reason why `curl | sh` might be objectionable to users. r? @steveklabnik
2015-10-22Auto merge of #29018 - tsion:doc-typo, r=steveklabnikbors-1/+1
r? @steveklabnik
2015-10-22Add missing "to" in Rustonomicon Atomics.Scott Olson-5/+5
2015-10-22Correct a previous patchYoshito Komatsu-1/+1
2015-10-21Auto merge of #29138 - ykomatsu:trpl2, r=Manishearthbors-8/+8
2015-10-21Fix some typos in TRPLYoshito Komatsu-3/+3
2015-10-21Auto merge of #29017 - ykomatsu:trpl, r=steveklabnikbors-5/+6
2015-10-21Auto merge of #29055 - alexcrichton:tiers, r=steveklabnikbors-15/+84
This commit expands the "supported platforms" section of the book to include documentation on the tiers that Rust currently has as well as organizing all supported platforms into these various tiers. Infrastructure improvements over the next few months are likely to change the location of may of these platforms over, but for now this should faithfully represent what we've got today!
2015-10-20Change headers in Traits section of the bookChris C Cerami-2/+2
2015-10-20Remove reference to `hello_world.rs` in TRPL §2.2Keshav Kini-2/+3
When reading this paragraph, the beginning Rust programmer is starting to write a Hello World program. We have just told her to name the file `main.rs`, and immediately afterward, a `hello_world.rs` is mentioned. I changed this to an unrelated filename (incidentally one that appears in this repository) to make it clear that this is just an example. Also, wording it as a declarative sentence rather than an imperative one further separates it from the Hello World instructions in this section.
2015-10-20Auto merge of #29148 - petrochenkov:noshow, r=alexcrichtonbors-4/+4
Closes https://github.com/rust-lang/rust/issues/29145 [breaking-change], needs a crater run.
2015-10-20doc: Clarify supported platforms and tiersAlex Crichton-15/+84
This commit expands the "supported platforms" section of the book to include documentation on the tiers that Rust currently has as well as organizing all supported platforms into these various tiers. Infrastructure improvements over the next few months are likely to change the location of may of these platforms over, but for now this should faithfully represent what we've got today!
2015-10-20Rollup merge of #29175 - durka:patch-8, r=GankroSteve Klabnik-0/+1
Yay, markdown isn't standardized and rustbook's parser has subtle incompatibilities with Github's! So in the Github preview you don't see that this list fails to separate from the previous paragraph. I think this should fix it, but I didn't check.
2015-10-20Rollup merge of #29162 - tsion:fix-nomicon-typo, r=alexcrichtonSteve Klabnik-1/+1
r? @steveklabnik
2015-10-19fix markdown in nomicon/dropckAlex Burka-0/+1
2015-10-19Replace -- with —Keshav Kini-1/+1
2015-10-19Rollup merge of #29169 - apasel422:spell, r=steveklabnikSteve Klabnik-1/+1
r? @steveklabnik
2015-10-19Rollup merge of #29168 - aarzee:master, r=steveklabnikSteve Klabnik-11/+11
Remove leading newlines; replace lines containing only whitespace with empty lines; replace multiple trailing newlines with a single newline; remove trailing whitespace in lines. This PR was created semiautomatically.
2015-10-19Correct spelling in docsAndrew Paseltiner-1/+1
2015-10-19Reword `curl | sh` disclaimer in TRPL §2.1Keshav Kini-5/+9
The paragraph here seemed confusing, so I reworded it. Also added another possible reason why `curl | sh` might be objectionable to users.
2015-10-19Clean whitespaceCarlos Liam-11/+11
Remove leading newlines; replace lines containing only whitespace with empty lines; replace multiple trailing newlines with a single newline; remove trailing whitespace in lines
2015-10-19Made the example capable of consistent deadlockingIrving A.J. Rivas Z.-3/+10
To augment the didactic effect, made placed the thread::sleep_ms call in the last example, so that there will be time for the other locks to happen; without this, I was unable to observe the deadlock in over 1,000 runs when there was no left-handed philosopher.
2015-10-19Fix minor syntax error in example.Scott Olson-1/+1
2015-10-19Change to avoid repeated "is"Yoshito Komatsu-5/+5
2015-10-18Remove #[derive(Show)]Vadim Petrochenkov-4/+4
2015-10-18Fix some typosYoshito Komatsu-4/+4
2015-10-17Auto merge of #29105 - billpmurphy:master, r=alexcrichtonbors-4/+3
Change the spacing/order of lines in the final pointer conversion example to make it more clear. Very small change, can be rolled up.
2015-10-17Auto merge of #29089 - kickinbahk:edit-testing-docs, r=steveklabnikbors-0/+3
When going through the docs, it is not clear that binary files cannot be tested. Additionally, it is hard to find the proper structure of a Rust crate and it took me several hours of looking through the docs to find the crates and modules section. I think we can link to it from here and it will be beneficial to those who are coming to the language.
2015-10-16Auto merge of #29082 - DenisKolodin:patch-3, r=alexcrichtonbors-2/+2
2015-10-16Update the testing doc to be more clear and include dynamic linkkickinbahk-1/+2
Fixed some typos and changed the link to the link to crates-and-modules to be dynamic.
2015-10-16Update explanation about offset methodDenisKolodin-2/+2