Skip to content

Commit 8de30cd

Browse files
authored
Rollup merge of rust-lang#101056 - kpreid:prim-doc, r=JohnTitor
Add the syntax of references to their documentation summary. Without this change, in <https://doc.rust-lang.org/1.63.0/std/#primitives>, `reference` is the only entry in that list which does not contain the syntax by which the type is named in source code. With this change, it contains them, in roughly the same way as the `pointer` entry does.
2 parents 3c1ba8b + e7d6b3f commit 8de30cd

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

core/src/primitive_docs.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1223,7 +1223,7 @@ mod prim_usize {}
12231223
#[doc(alias = "&")]
12241224
#[doc(alias = "&mut")]
12251225
//
1226-
/// References, both shared and mutable.
1226+
/// References, `&T` and `&mut T`.
12271227
///
12281228
/// A reference represents a borrow of some owned value. You can get one by using the `&` or `&mut`
12291229
/// operators on a value, or by using a [`ref`](../std/keyword.ref.html) or

std/src/primitive_docs.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1223,7 +1223,7 @@ mod prim_usize {}
12231223
#[doc(alias = "&")]
12241224
#[doc(alias = "&mut")]
12251225
//
1226-
/// References, both shared and mutable.
1226+
/// References, `&T` and `&mut T`.
12271227
///
12281228
/// A reference represents a borrow of some owned value. You can get one by using the `&` or `&mut`
12291229
/// operators on a value, or by using a [`ref`](../std/keyword.ref.html) or

0 commit comments

Comments
 (0)