about summary refs log tree commit diff
path: root/src/doc/book
AgeCommit message (Collapse)AuthorLines
2015-12-26llvm: Add support for vectorcall (X86_VectorCall) conventionSteffen-0/+1
2015-12-26book: Fix typoOri Avtalion-1/+1
2015-12-25Rollup merge of #30545 - bluss:operator-overload, r=steveklabnikManish Goregaokar-5/+6
book: Some operator fixes for the syntax index - Correct the names of the comparison traits (PartialOrd) - Mention only the traits that overload the operator (PartialOrd, PartialEq), not operator-unrelated traits (Ord, Eq). - Add `!=` operator.
2015-12-24book: Some operator fixes for the syntax indexUlrik Sverdrup-5/+6
- Correct the names of the comparison traits (PartialOrd) - Mention only the traits that overload the operator (PartialOrd, PartialEq), not operator-unrelated traits (Ord, Eq). - Add `!=` operator.
2015-12-23Rollup merge of #30473 - nwin:patch-2, r=steveklabnikSteve Klabnik-1/+1
Clarify the difference between compiler-panic and libcore-panic.
2015-12-23Rollup merge of #30461 - lnmx:doc-typo, r=steveklabnikSteve Klabnik-1/+1
2015-12-21Auto merge of #30400 - fbergr:master, r=steveklabnikbors-1/+1
See: https://github.com/rust-lang/rust/issues/30397 r? @steveklabnik
2015-12-21Revert to colon. The text is introducing a list.Luke Jones-1/+1
2015-12-21Update patterns.mdLuke Jones-1/+1
2015-12-21Correct line wrapLuke Jones-4/+12
2015-12-21Rewrite paragraph in 'match' to be more concise and readable. StartLuke Jones-18/+10
correcting use of ':' in sentences. The colon `:` should be used only when the sentence preceeding it is a complete sentence. If this is not the case, then a `;` should be used; this denotes that the following fragment is a part of the previous fragment.
2015-12-19Update no-stdlib.mdnwin-1/+1
Clarify the difference between compiler-panic and libcore-panic.
2015-12-18doc: minor format fixes in book/error-handlinglnmx-1/+1
2015-12-18Rollup merge of #30447 - Xmasreturns:Docu, r=steveklabnikManish Goregaokar-4/+6
Added sentences for description of code and changed x in the example to an int
2015-12-18Rollup merge of #30406 - durka:patch-13, r=sanxiynManish Goregaokar-3/+3
The previous example had no chance of compiling in either form, due to the restrictive follow set for `ty`. This one has the desired behavior: http://is.gd/kYdw4g (well, I don't exactly desire this behavior at all, but it's true at least :p )
2015-12-17Clarified shadowing exampleXmasreturns-4/+6
Added some additional descriptive sentences and changed x to an int in the example
2015-12-16Used bold and italic in the markdown to make the stack and heap ↵Shiney-20/+22
documentation clearer
2015-12-15change macro ambiguity example from ty to identAlex Burka-3/+3
The previous example had no chance of compiling in either form, due to the restrictive follow set for `ty`. This one has the desired behavior: http://is.gd/kYdw4g (well, I don't exactly desire this behavior at all, but it's true at least :p )
2015-12-15remove claim that $crate is a single identifierAlex Burka-2/+1
Fixes #30217.
2015-12-15Book: Fix link anchor in Syntax Indexfbergr-1/+1
2015-12-13Auto merge of #30329 - salty-horse:punctuation, r=steveklabnikbors-1/+1
Missing period at the end of a sentence.
2015-12-13Auto merge of #30310 - mbrubeck:doc-vec-bounds, r=steveklabnikbors-0/+30
r? @steveklabnik Currently neither the API docs nor the book clearly explain that out-of-bounds array indexing causes a panic. Since this is fairly important and seems to surprise a number of new Rust programmers, I think it's worth adding to both places. (But if you think it would be better to put this info in the API docs only, that's fine too.) Some specific things I'd like feedback on: * The new text here talks about panicking, which hasn't been formally introduced at this point in chapter 5 (though it has been mentioned in previous sections too). * Similarly the `Vec::get` example uses `Option<T>` which hasn't been fully introduced yet. Should we leave out this example?
2015-12-12Auto merge of #30309 - alexcrichton:more-tier-two, r=steveklabnikbors-24/+24
We've got lots of new automation set up in the past few months, so these platforms are now all tier 2 as we're building artifacts and gating on them.
2015-12-11book: Add missing punctuationOri Avtalion-1/+1
2015-12-11Document bounds checking in the bookMatt Brubeck-0/+30
2015-12-10book: Update Tier 2 platformsAlex Crichton-24/+24
We've got lots of new automation set up in the past few months, so these platforms are now all tier 2 as we're building artifacts and gating on them.
2015-12-10Auto merge of #30292 - Xmasreturns:patch-3, r=steveklabnikbors-24/+22
Updated structs.md in the book
2015-12-09Fixes from reviewXmasreturns-2/+2
Traits -> Field labels Revert a change to convention
2015-12-09Grammar and slight ordering changesXmasreturns-25/+23
2015-12-09Grammar changes for readabilityXmasreturns-8/+8
2015-12-09Rollup merge of #30273 - Xmasreturns:patch-1, r=steveklabnikSteve Klabnik-14/+10
Changes to readability and some clarifications for beginners
2015-12-08Update traits.mdXmasreturns-1/+1
2015-12-08Update traits.mdXmasreturns-14/+10
Changes to readability and some clarifications for beginners
2015-12-08Re-order the sections in TRPLSteve Klabnik-12/+12
This ordering was significantly more confusing.
2015-12-06Auto merge of #30234 - vyp:doc-typo, r=apasel422bors-1/+1
2015-12-06doc(book/error-handling): fix typoxd1le-1/+1
2015-12-06Auto merge of #30221 - thyrgle:concurrency_doc, r=alexcrichtonbors-3/+3
The example code in the Channels subsection of the rust book give warnings about unused result which must be used, #[warn(unused_must_use)] on by default Added a small pattern match to resolve those warnings.
2015-12-06Auto merge of #30187 - alexcrichton:stabilize-1.6, r=aturonbors-7/+1
This commit is the standard API stabilization commit for the 1.6 release cycle. The list of issues and APIs below have all been through their cycle-long FCP and the libs team decisions are listed below Stabilized APIs * `Read::read_exact` * `ErrorKind::UnexpectedEof` (renamed from `UnexpectedEOF`) * libcore -- this was a bit of a nuanced stabilization, the crate itself is now marked as `#[stable]` and the methods appearing via traits for primitives like `char` and `str` are now also marked as stable. Note that the extension traits themeselves are marked as unstable as they're imported via the prelude. The `try!` macro was also moved from the standard library into libcore to have the same interface. Otherwise the functions all have copied stability from the standard library now. * `fs::DirBuilder` * `fs::DirBuilder::new` * `fs::DirBuilder::recursive` * `fs::DirBuilder::create` * `os::unix::fs::DirBuilderExt` * `os::unix::fs::DirBuilderExt::mode` * `vec::Drain` * `vec::Vec::drain` * `string::Drain` * `string::String::drain` * `vec_deque::Drain` * `vec_deque::VecDeque::drain` * `collections::hash_map::Drain` * `collections::hash_map::HashMap::drain` * `collections::hash_set::Drain` * `collections::hash_set::HashSet::drain` * `collections::binary_heap::Drain` * `collections::binary_heap::BinaryHeap::drain` * `Vec::extend_from_slice` (renamed from `push_all`) * `Mutex::get_mut` * `Mutex::into_inner` * `RwLock::get_mut` * `RwLock::into_inner` * `Iterator::min_by_key` (renamed from `min_by`) * `Iterator::max_by_key` (renamed from `max_by`) Deprecated APIs * `ErrorKind::UnexpectedEOF` (renamed to `UnexpectedEof`) * `OsString::from_bytes` * `OsStr::to_cstring` * `OsStr::to_bytes` * `fs::walk_dir` and `fs::WalkDir` * `path::Components::peek` * `slice::bytes::MutableByteVector` * `slice::bytes::copy_memory` * `Vec::push_all` (renamed to `extend_from_slice`) * `Duration::span` * `IpAddr` * `SocketAddr::ip` * `Read::tee` * `io::Tee` * `Write::broadcast` * `io::Broadcast` * `Iterator::min_by` (renamed to `min_by_key`) * `Iterator::max_by` (renamed to `max_by_key`) * `net::lookup_addr` New APIs (still unstable) * `<[T]>::sort_by_key` (added to mirror `min_by_key`) Closes #27585 Closes #27704 Closes #27707 Closes #27710 Closes #27711 Closes #27727 Closes #27740 Closes #27744 Closes #27799 Closes #27801 cc #27801 (doesn't close as `Chars` is still unstable) Closes #28968
2015-12-05std: Stabilize APIs for the 1.6 releaseAlex Crichton-7/+1
This commit is the standard API stabilization commit for the 1.6 release cycle. The list of issues and APIs below have all been through their cycle-long FCP and the libs team decisions are listed below Stabilized APIs * `Read::read_exact` * `ErrorKind::UnexpectedEof` (renamed from `UnexpectedEOF`) * libcore -- this was a bit of a nuanced stabilization, the crate itself is now marked as `#[stable]` and the methods appearing via traits for primitives like `char` and `str` are now also marked as stable. Note that the extension traits themeselves are marked as unstable as they're imported via the prelude. The `try!` macro was also moved from the standard library into libcore to have the same interface. Otherwise the functions all have copied stability from the standard library now. * The `#![no_std]` attribute * `fs::DirBuilder` * `fs::DirBuilder::new` * `fs::DirBuilder::recursive` * `fs::DirBuilder::create` * `os::unix::fs::DirBuilderExt` * `os::unix::fs::DirBuilderExt::mode` * `vec::Drain` * `vec::Vec::drain` * `string::Drain` * `string::String::drain` * `vec_deque::Drain` * `vec_deque::VecDeque::drain` * `collections::hash_map::Drain` * `collections::hash_map::HashMap::drain` * `collections::hash_set::Drain` * `collections::hash_set::HashSet::drain` * `collections::binary_heap::Drain` * `collections::binary_heap::BinaryHeap::drain` * `Vec::extend_from_slice` (renamed from `push_all`) * `Mutex::get_mut` * `Mutex::into_inner` * `RwLock::get_mut` * `RwLock::into_inner` * `Iterator::min_by_key` (renamed from `min_by`) * `Iterator::max_by_key` (renamed from `max_by`) Deprecated APIs * `ErrorKind::UnexpectedEOF` (renamed to `UnexpectedEof`) * `OsString::from_bytes` * `OsStr::to_cstring` * `OsStr::to_bytes` * `fs::walk_dir` and `fs::WalkDir` * `path::Components::peek` * `slice::bytes::MutableByteVector` * `slice::bytes::copy_memory` * `Vec::push_all` (renamed to `extend_from_slice`) * `Duration::span` * `IpAddr` * `SocketAddr::ip` * `Read::tee` * `io::Tee` * `Write::broadcast` * `io::Broadcast` * `Iterator::min_by` (renamed to `min_by_key`) * `Iterator::max_by` (renamed to `max_by_key`) * `net::lookup_addr` New APIs (still unstable) * `<[T]>::sort_by_key` (added to mirror `min_by_key`) Closes #27585 Closes #27704 Closes #27707 Closes #27710 Closes #27711 Closes #27727 Closes #27740 Closes #27744 Closes #27799 Closes #27801 cc #27801 (doesn't close as `Chars` is still unstable) Closes #28968
2015-12-05Uses unwrap instead of pattern matchingChristopher Sumnicht-3/+3
2015-12-05Resolved warnings about unused resultChristopher Sumnicht-3/+3
2015-12-04Fix typoJake Worth-1/+1
2015-12-03Auto merge of #30169 - shepmaster:for-loop-into-iterator, r=steveklabnikbors-5/+7
2015-12-02Clarify that a for loop uses `IntoIterator`Jake Goulding-5/+7
2015-12-02Auto merge of #30161 - JIghtuse:master, r=steveklabnikbors-1/+3
2015-12-02book: Provide link to tuple structs in type aliases chapterBoris Egorov-1/+3
2015-12-01Rollup merge of #30154 - salty-horse:guessing_panic, r=steveklabnikSteve Klabnik-1/+1
The text mentions ```return```, but what's actually happening is a ```panic!```.
2015-12-01Rollup merge of #30153 - durka:patch-11, r=steveklabnikSteve Klabnik-9/+16
I think this fixes #30137. I basically just repeated some details that were scattered around other places in this document, and emphasized that you probably don't want an `extern crate` or `mod` statement to end up inside a function.
2015-12-01Rollup merge of #30144 - pjungwir:clarify-semver-rules, r=steveklabnikSteve Klabnik-3/+7
The documentation shows this: [dependencies] rand="0.3.0" and says it allows any version compatible with 0.3.0, but then it says, "If we wanted to use only 0.3.0 exactly, we could use `=0.3.0`." That is very easy to misunderstand, so hopefully this PR will help others not to be as confused as me. :-)
2015-12-01Rollup merge of #30134 - salty-horse:patch-1, r=steveklabnikSteve Klabnik-2/+2
random/secret guess -> secret number.