Skip to content

Commit 5bcbd0f

Browse files
authored
Rollup merge of #80146 - pierwill:pierwill-prelude-mod-docs, r=lcnr
Edit formatting in Rust Prelude docs Use consistent punctuation and capitalization in the list of things re-exported in the prelude. Also adds a (possibly missing) word.
2 parents 22a26db + ea338f5 commit 5bcbd0f

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

library/std/src/prelude/mod.rs

+12-13
Original file line numberDiff line numberDiff line change
@@ -26,38 +26,37 @@
2626
//! # Prelude contents
2727
//!
2828
//! The current version of the prelude (version 1) lives in
29-
//! [`std::prelude::v1`], and re-exports the following.
29+
//! [`std::prelude::v1`], and re-exports the following:
3030
//!
31-
//! * [`std::marker`]::{[`Copy`], [`Send`], [`Sized`], [`Sync`], [`Unpin`]}. The
32-
//! marker traits indicate fundamental properties of types.
33-
//! * [`std::ops`]::{[`Drop`], [`Fn`], [`FnMut`], [`FnOnce`]}. Various
31+
//! * [`std::marker`]::{[`Copy`], [`Send`], [`Sized`], [`Sync`], [`Unpin`]},
32+
//! marker traits that indicate fundamental properties of types.
33+
//! * [`std::ops`]::{[`Drop`], [`Fn`], [`FnMut`], [`FnOnce`]}, various
3434
//! operations for both destructors and overloading `()`.
3535
//! * [`std::mem`]::[`drop`][`mem::drop`], a convenience function for explicitly
3636
//! dropping a value.
3737
//! * [`std::boxed`]::[`Box`], a way to allocate values on the heap.
38-
//! * [`std::borrow`]::[`ToOwned`], The conversion trait that defines
38+
//! * [`std::borrow`]::[`ToOwned`], the conversion trait that defines
3939
//! [`to_owned`], the generic method for creating an owned type from a
4040
//! borrowed type.
4141
//! * [`std::clone`]::[`Clone`], the ubiquitous trait that defines
4242
//! [`clone`][`Clone::clone`], the method for producing a copy of a value.
43-
//! * [`std::cmp`]::{[`PartialEq`], [`PartialOrd`], [`Eq`], [`Ord`] }. The
43+
//! * [`std::cmp`]::{[`PartialEq`], [`PartialOrd`], [`Eq`], [`Ord`] }, the
4444
//! comparison traits, which implement the comparison operators and are often
4545
//! seen in trait bounds.
46-
//! * [`std::convert`]::{[`AsRef`], [`AsMut`], [`Into`], [`From`]}. Generic
46+
//! * [`std::convert`]::{[`AsRef`], [`AsMut`], [`Into`], [`From`]}, generic
4747
//! conversions, used by savvy API authors to create overloaded methods.
4848
//! * [`std::default`]::[`Default`], types that have default values.
49-
//! * [`std::iter`]::{[`Iterator`], [`Extend`], [`IntoIterator`],
50-
//! [`DoubleEndedIterator`], [`ExactSizeIterator`]}. Iterators of various
49+
//! * [`std::iter`]::{[`Iterator`], [`Extend`], [`IntoIterator`]
50+
//! [`DoubleEndedIterator`], [`ExactSizeIterator`]}, iterators of various
5151
//! kinds.
52-
//! * [`std::option`]::[`Option`]::{[`self`][`Option`], [`Some`], [`None`]}. A
52+
//! * [`std::option`]::[`Option`]::{[`self`][`Option`], [`Some`], [`None`]}, a
5353
//! type which expresses the presence or absence of a value. This type is so
5454
//! commonly used, its variants are also exported.
55-
//! * [`std::result`]::[`Result`]::{[`self`][`Result`], [`Ok`], [`Err`]}. A type
55+
//! * [`std::result`]::[`Result`]::{[`self`][`Result`], [`Ok`], [`Err`]}, a type
5656
//! for functions that may succeed or fail. Like [`Option`], its variants are
5757
//! exported as well.
5858
//! * [`std::string`]::{[`String`], [`ToString`]}, heap allocated strings.
59-
//! * [`std::vec`]::[`Vec`], a growable, heap-allocated
60-
//! vector.
59+
//! * [`std::vec`]::[`Vec`], a growable, heap-allocated vector.
6160
//!
6261
//! [`mem::drop`]: crate::mem::drop
6362
//! [`std::borrow`]: crate::borrow

0 commit comments

Comments
 (0)