Skip to content

Commit 7f91371

Browse files
authored
Rollup merge of rust-lang#80172 - camelid:prelude-docs-consistent-punct, r=steveklabnik
Use consistent punctuation for 'Prelude contents' docs
2 parents 2c51252 + b736d9a commit 7f91371

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

std/src/io/prelude.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! The I/O Prelude
1+
//! The I/O Prelude.
22
//!
33
//! The purpose of this module is to alleviate imports of many common I/O traits
44
//! by adding a glob import to the top of I/O heavy modules:

std/src/prelude/mod.rs

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! The Rust Prelude.
1+
//! # The Rust Prelude
22
//!
33
//! Rust comes with a variety of things in its standard library. However, if
44
//! you had to manually import every single thing that you used, it would be
@@ -28,35 +28,35 @@
2828
//! The current version of the prelude (version 1) lives in
2929
//! [`std::prelude::v1`], and re-exports the following:
3030
//!
31-
//! * [`std::marker`]::{[`Copy`], [`Send`], [`Sized`], [`Sync`], [`Unpin`]},
31+
//! * [`std::marker`]::{[`Copy`], [`Send`], [`Sized`], [`Sync`], [`Unpin`]}:
3232
//! marker traits that indicate fundamental properties of types.
33-
//! * [`std::ops`]::{[`Drop`], [`Fn`], [`FnMut`], [`FnOnce`]}, various
33+
//! * [`std::ops`]::{[`Drop`], [`Fn`], [`FnMut`], [`FnOnce`]}: various
3434
//! operations for both destructors and overloading `()`.
35-
//! * [`std::mem`]::[`drop`][`mem::drop`], a convenience function for explicitly
35+
//! * [`std::mem`]::[`drop`][`mem::drop`]: a convenience function for explicitly
3636
//! dropping a value.
37-
//! * [`std::boxed`]::[`Box`], a way to allocate values on the heap.
38-
//! * [`std::borrow`]::[`ToOwned`], the conversion trait that defines
37+
//! * [`std::boxed`]::[`Box`]: a way to allocate values on the heap.
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.
41-
//! * [`std::clone`]::[`Clone`], the ubiquitous trait that defines
41+
//! * [`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.
5252
//! * [`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.
58-
//! * [`std::string`]::{[`String`], [`ToString`]}, heap allocated strings.
59-
//! * [`std::vec`]::[`Vec`], a growable, heap-allocated vector.
58+
//! * [`std::string`]::{[`String`], [`ToString`]}: heap-allocated strings.
59+
//! * [`std::vec`]::[`Vec`]: a growable, heap-allocated vector.
6060
//!
6161
//! [`mem::drop`]: crate::mem::drop
6262
//! [`std::borrow`]: crate::borrow

0 commit comments

Comments
 (0)