Skip to content

Commit 311ad55

Browse files
committed
Add primitive documentation for f16 and f128
1 parent 143ecc3 commit 311ad55

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

library/core/src/primitive_docs.rs

+30
Original file line numberDiff line numberDiff line change
@@ -1074,7 +1074,22 @@ mod prim_tuple {}
10741074
#[doc(hidden)]
10751075
impl<T> (T,) {}
10761076

1077+
#[rustc_doc_primitive = "f16"]
1078+
#[doc(alias = "half")]
1079+
/// A 16-bit floating point type (specifically, the "binary16" type defined in IEEE 754-2008).
1080+
///
1081+
/// This type is very similar to [`prim@f32`] but has decreased precision because it uses half as many
1082+
/// bits. Please see [the documentation for [`prim@f32`] or [Wikipedia on
1083+
/// half-precision values][wikipedia] for more information.
1084+
///
1085+
/// *[See also the `std::f16::consts` module](crate::f16::consts).*
1086+
///
1087+
/// [wikipedia]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
1088+
#[unstable(feature = "f16", issue = "116909")]
1089+
mod prim_f16 {}
1090+
10771091
#[rustc_doc_primitive = "f32"]
1092+
#[doc(alias = "single")]
10781093
/// A 32-bit floating point type (specifically, the "binary32" type defined in IEEE 754-2008).
10791094
///
10801095
/// This type can represent a wide range of decimal numbers, like `3.5`, `27`,
@@ -1143,6 +1158,7 @@ impl<T> (T,) {}
11431158
mod prim_f32 {}
11441159

11451160
#[rustc_doc_primitive = "f64"]
1161+
#[doc(alias = "double")]
11461162
/// A 64-bit floating point type (specifically, the "binary64" type defined in IEEE 754-2008).
11471163
///
11481164
/// This type is very similar to [`f32`], but has increased
@@ -1157,6 +1173,20 @@ mod prim_f32 {}
11571173
#[stable(feature = "rust1", since = "1.0.0")]
11581174
mod prim_f64 {}
11591175

1176+
#[rustc_doc_primitive = "f128"]
1177+
#[doc(alias = "quad")]
1178+
/// A 128-bit floating point type (specifically, the "binary128" type defined in IEEE 754-2008).
1179+
///
1180+
/// This type is very similar to [`prim@f32`] and [`prim@f64`], but has increased precision by using twice
1181+
/// as many bits as `f64`. Please see [the documentation for [`prim@f32`] or [Wikipedia on
1182+
/// quad-precision values][wikipedia] for more information.
1183+
///
1184+
/// *[See also the `std::f128::consts` module](crate::f128::consts).*
1185+
///
1186+
/// [wikipedia]: https://en.wikipedia.org/wiki/Quadruple-precision_floating-point_format
1187+
#[unstable(feature = "f128", issue = "116909")]
1188+
mod prim_f128 {}
1189+
11601190
#[rustc_doc_primitive = "i8"]
11611191
//
11621192
/// The 8-bit signed integer type.

0 commit comments

Comments
 (0)