summary refs log tree commit diff
path: root/src/libstd/primitive_docs.rs
AgeCommit message (Collapse)AuthorLines
2017-10-17Update array documentation for Clone trait changesKonrad Borowski-3/+4
2017-09-20Document stable size_of primitives and pointer size guaranteesHavvy-0/+8
2017-08-22Mention null_mut on the pointer primitive docs.Nathaniel Ringo-3/+5
Also adds a few mentions that both `*const` and `*mut` support functions, when only `*const` was mentioned before.
2017-08-17Minor rewrite of char primitive unicode intro.Corey Farwell-13/+18
Opened primarily to address #36998.
2017-08-12Fix some typosBastien Orivel-1/+1
2017-08-01add documentation for function pointers as a primitiveQuietMisdreavus-0/+101
2017-07-30add docs for references as a primitiveQuietMisdreavus-0/+117
2017-06-23Removed as many "```ignore" as possible.kennytm-2/+4
Replaced by adding extra imports, adding hidden code (`# ...`), modifying examples to be runnable (sorry Homura), specifying non-Rust code, and converting to should_panic, no_run, or compile_fail. Remaining "```ignore"s received an explanation why they are being ignored.
2017-04-12Rollup merge of #41243 - projektir:prim_str_docs, r=GuillaumeGomezTim Neumann-4/+4
Minor nits in primitive str Some minor updates to linking, added some links, doc format, etc. r? @GuillaumeGomez
2017-04-12Minor nits in primitive strprojektir-4/+4
2017-04-10Fixes incorrect formatting in array's documentation.Nathaniel Ringo-1/+1
2017-03-31Rollup merge of #40703 - GuillaumeGomez:pointer-docs, r=steveklabnikCorey Farwell-4/+9
Add missing urls in ptr docs r? @rust-lang/docs
2017-03-21Add missing urls in ptr docsGuillaume Gomez-4/+9
2017-03-20Fix up various linkssteveklabnik-2/+2
The unstable book, libstd, libcore, and liballoc all needed some adjustment.
2017-03-13Remove function invokation parens from documentation links.Corey Farwell-3/+3
This was never established as a convention we should follow in the 'More API Documentation Conventions' RFC: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md
2017-02-20Revert "Fix up links"Steve Klabnik-1/+1
This reverts commit 7f1d1c6d9a7be5e427bace30e740b16b25f25c92. The original commit was created because mdBook and rustdoc had different generation algorithms for header links; now with https://github.com/rust-lang/rust/pull/39966 , the algorithms are the same. So let's undo this change. ... when I came across this problem, I said "eh, this isn't fun, but it doesn't take that long." I probably should have just actually taken the time to fix upstream, given that they were amenable. Oh well!
2017-02-13Fix up linksSteve Klabnik-1/+1
mdbook and rustdoc generate links differently, so we need to change all these links.
2017-01-24Add missing urls for array docsGuillaume Gomez-21/+22
2017-01-21Specify the result of integer cast on booleanGuillaume Gomez-1/+9
2017-01-15rustdoc: Give primitive types stability attributesOliver Middleton-0/+22
This is especially important for i128/u128 to make it clear they are unstable in the docs.
2017-01-05Fix typo in tuple docsOliver Middleton-1/+1
2016-12-30Make rustdoc aware of the primitive i128 typeest31-0/+22
Many thanks to ollie27 for spotting all the places.
2016-10-08Use less `size_t` casts in libstd since it's now defined as `usize`Tobias Bucher-1/+1
2016-09-11Tweak array docsKeegan McAllister-21/+65
Fixes #29331.
2016-08-18Fix linksNick Cameron-1/+1
2016-08-17Rollup merge of #35613 - matthew-piziak:array-docs-trait-justification, ↵Jonathan Turner-3/+8
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-12provide additional justification for array interface designMatthew Piziak-3/+8
Explain why Rust does not implement traits for large arrays. Explain why most methods are implemented on slices rather than arrays.
2016-08-12Update note to include recommendation to use `.as_slice()`JessRudder-1/+2
2016-08-11Add note to docs for &str that example is to demo internals onlyJessRudder-0/+3
2016-07-08Improve primitive integers documentationGuillaume Gomez-0/+30
2016-06-22Use the correct types in float examplesOliver Middleton-6/+0
2016-06-01Fix broken link name in `bool` documentationMatt Kraai-1/+1
2016-04-06Add `Copy` to the traits that are automatically implemented for tuplesTobias Bucher-2/+4
2016-03-22doc: small char improvementsTshepang Lekhonkhobe-3/+3
2016-03-08doc: Fix a bunch of broken linksAlex Crichton-15/+15
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-06Spelling fix for "because"Craig M. Brandenburg-1/+1
2016-02-25Add f32 and f64 examples warningGuillaume Gomez-0/+6
2016-02-24Updated the primitive docs for boolRavi Shankar-1/+44
2016-02-15correct the primitive char doc's use of bytes and code pointsJack O'Connor-21/+11
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-09make note of arity and 32-length restrictionSteve Klabnik-0/+6
2016-02-09Properly document tuplesSteve Klabnik-27/+65
Fixes #29339
2015-12-16small fix to str doc exampleSteve Klabnik-1/+1
2015-12-09Fix extra space in str docsSteve Klabnik-1/+1
2015-12-01Auto merge of #30129 - tbu-:pr_doc_arrays_coerce, r=steveklabnikbors-6/+6
Fixes #29993.
2015-12-01Arrays don't dereference but coerce to slicesTobias Bucher-6/+6
Fixes #29993.
2015-11-30Better docs for the str primitiveSteve Klabnik-22/+42
Part of #29338
2015-11-24Fix up docs for charSteve Klabnik-11/+72
Part of https://github.com/rust-lang/rust/issues/29333
2015-11-07Update list of array implementations in src/libstd/primitive_docs.rsOliver Middleton-1/+3
2015-09-30Fix typo in docs: usize is unsigned, not signed.Dato Simó-1/+1
2015-09-11std: Stabilize/deprecate features for 1.4Alex Crichton-2/+0
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
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-25 15:24:08 +0000