54c680cdb1
Tweak array docs
...
Fixes #29331 .
2016-09-11 12:36:24 -07:00
e6cc4c5d13
Fix links
2016-08-18 15:43:35 +12:00
559bfd68e3
Rollup merge of #35613 - matthew-piziak:array-docs-trait-justification, r=steveklabnik
...
provide additional justification for array interface design
Explain why Rust does not implement traits for large arrays.
Explain why most methods are implemented on slices rather than arrays.
Note: I'm dipping my toes in the water with a tiny PR. Especially looking for feedback on wording and style. Points of concern: appropriate level of top-level explanation; foreshadowing (is it appropriate to imply that we expect Rust's type system to eventually support size-generic arrays?); using `Foo` and `Bar` as type variables instead of e.g. `T` and `S`.
@peschkaj
2016-08-17 06:25:24 -07:00
e173ead684
provide additional justification for array interface design
...
Explain why Rust does not implement traits for large arrays.
Explain why most methods are implemented on slices rather than arrays.
2016-08-12 12:12:54 -04:00
758aff7883
Update note to include recommendation to use .as_slice()
2016-08-12 10:39:40 -04:00
91a2c25e2e
Add note to docs for &str that example is to demo internals only
2016-08-11 18:47:47 -04:00
a6bbd0c1ca
Improve primitive integers documentation
2016-07-08 23:03:17 +02:00
f1531254af
Use the correct types in float examples
2016-06-22 23:33:07 +01:00
68ac3e9ff0
Fix broken link name in bool documentation
2016-06-01 05:32:11 -07:00
3e9b859af2
Add Copy to the traits that are automatically implemented for tuples
2016-04-06 20:10:33 +02:00
7d626e9f55
doc: small char improvements
2016-03-22 08:29:55 +02:00
73db76015e
doc: Fix a bunch of broken links
...
A few categories:
* Links into compiler docs were just all removed as we're not generating
compiler docs.
* Move up one more level to forcibly go to std docs to fix inlined documentation
across the facade crates.
2016-03-08 13:44:14 -08:00
b517256941
Spelling fix for "because"
2016-03-06 08:37:30 -07:00
25c62ebfdd
Add f32 and f64 examples warning
2016-02-25 10:15:13 +01:00
eb97c26d3b
Updated the primitive docs for bool
2016-02-24 01:15:28 +05:30
071b4b6f7b
correct the primitive char doc's use of bytes and code points
...
Previously the docs suggested that '❤️ ' doesn't fit in a char because
it's 6 bytes. But that's misleading. 'a̚' also doesn't fit in a char,
even though it's only 3 bytes. The important thing is the number of code
points, not the number of bytes. Clarify the primitive char docs around
this.
2016-02-15 21:28:54 -05:00
8fa48573e1
make note of arity and 32-length restriction
2016-02-09 16:00:54 -05:00
4ebc47bad2
Properly document tuples
...
Fixes #29339
2016-02-09 16:00:50 -05:00
4e2ec9a178
small fix to str doc example
2015-12-16 22:12:47 -05:00
77882c9cba
Fix extra space in str docs
2015-12-09 15:52:04 -05:00
2f95de3b3b
Auto merge of #30129 - tbu-:pr_doc_arrays_coerce, r=steveklabnik
...
Fixes #29993 .
2015-12-01 23:35:54 +00:00
53f026948a
Arrays don't dereference but coerce to slices
...
Fixes #29993 .
2015-12-01 02:13:35 +00:00
7b30f5c256
Better docs for the str primitive
...
Part of #29338
2015-11-30 16:10:47 -05:00
10c6737ecf
Fix up docs for char
...
Part of https://github.com/rust-lang/rust/issues/29333
2015-11-24 13:25:55 -05:00
4f6eb1e93a
Update list of array implementations in src/libstd/primitive_docs.rs
2015-11-07 12:01:11 +00:00
7914d1b8b7
Fix typo in docs: usize is unsigned, not signed.
2015-09-30 01:18:23 -03:00
f0b1326dc7
std: Stabilize/deprecate features for 1.4
...
The FCP is coming to a close and 1.4 is coming out soon, so this brings in the
libs team decision for all library features this cycle.
Stabilized APIs:
* `<Box<str>>::into_string`
* `Arc::downgrade`
* `Arc::get_mut`
* `Arc::make_mut`
* `Arc::try_unwrap`
* `Box::from_raw`
* `Box::into_raw`
* `CStr::to_str`
* `CStr::to_string_lossy`
* `CString::from_raw`
* `CString::into_raw`
* `IntoRawFd::into_raw_fd`
* `IntoRawFd`
* `IntoRawHandle::into_raw_handle`
* `IntoRawHandle`
* `IntoRawSocket::into_raw_socket`
* `IntoRawSocket`
* `Rc::downgrade`
* `Rc::get_mut`
* `Rc::make_mut`
* `Rc::try_unwrap`
* `Result::expect`
* `String::into_boxed_slice`
* `TcpSocket::read_timeout`
* `TcpSocket::set_read_timeout`
* `TcpSocket::set_write_timeout`
* `TcpSocket::write_timeout`
* `UdpSocket::read_timeout`
* `UdpSocket::set_read_timeout`
* `UdpSocket::set_write_timeout`
* `UdpSocket::write_timeout`
* `Vec::append`
* `Vec::split_off`
* `VecDeque::append`
* `VecDeque::retain`
* `VecDeque::split_off`
* `rc::Weak::upgrade`
* `rc::Weak`
* `slice::Iter::as_slice`
* `slice::IterMut::into_slice`
* `str::CharIndices::as_str`
* `str::Chars::as_str`
* `str::split_at_mut`
* `str::split_at`
* `sync::Weak::upgrade`
* `sync::Weak`
* `thread::park_timeout`
* `thread::sleep`
Deprecated APIs
* `BTreeMap::with_b`
* `BTreeSet::with_b`
* `Option::as_mut_slice`
* `Option::as_slice`
* `Result::as_mut_slice`
* `Result::as_slice`
* `f32::from_str_radix`
* `f64::from_str_radix`
Closes #27277
Closes #27718
Closes #27736
Closes #27764
Closes #27765
Closes #27766
Closes #27767
Closes #27768
Closes #27769
Closes #27771
Closes #27773
Closes #27775
Closes #27776
Closes #27785
Closes #27792
Closes #27795
Closes #27797
2015-09-11 09:48:48 -07:00
ba5fcb726f
Show appropriate feature flags in docs
2015-07-27 12:28:13 -04:00
778c89c1bb
Address feedback
2015-07-20 17:12:59 -07:00
8497c428e5
std: Create separate docs for the primitives
...
Having the primitive and module docs derived from the same source
causes problems, primarily that they can't contain hyperlinks
cross-referencing each other.
This crates dedicated private modules in `std` to document the
primitive types, then for all primitives that have a corresponding
module, puts hyperlinks in moth the primitive docs and the module docs
cross-linking each other.
This should help clear up confusion when readers find themselves on
the wrong page.
2015-07-20 13:18:06 -07:00
Keegan McAllister