mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #129645 - beetrees:fix-float-docs, r=tgross35

Browse Source 
Fix typos in floating-point primitive type docs

Fixes a few typos. Also reflows the text of a couple of paragraphs in the source code to the standard line width to make the source easier to read (will have no effect on the rendered documentation).
This commit is contained in:
Matthias Krüger 2024-08-27 18:59:29 +02:00 committed by GitHub
commit 02491259c2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
library/core/src/primitive_docs.rs
View File

@ -1130,8 +1130,8 @@ impl<T> (T,) {}
/// A 16-bit floating point type (specifically, the "binary16" type defined in IEEE 754-2008). /// A 16-bit floating point type (specifically, the "binary16" type defined in IEEE 754-2008).
/// ///
/// This type is very similar to [`prim@f32`] but has decreased precision because it uses half as many /// This type is very similar to [`prim@f32`] but has decreased precision because it uses half as many
/// bits. Please see [the documentation for [`prim@f32`] or [Wikipedia on /// bits. Please see [the documentation for `f32`](prim@f32) or [Wikipedia on half-precision
/// half-precision values][wikipedia] for more information. /// values][wikipedia] for more information.
/// ///
/// Note that most common platforms will not support `f16` in hardware without enabling extra target /// Note that most common platforms will not support `f16` in hardware without enabling extra target
/// features, with the notable exception of Apple Silicon (also known as M1, M2, etc.) processors. /// features, with the notable exception of Apple Silicon (also known as M1, M2, etc.) processors.
@ -1296,14 +1296,12 @@ mod prim_f32 {}
#[doc(alias = "double")] #[doc(alias = "double")]
/// A 64-bit floating point type (specifically, the "binary64" type defined in IEEE 754-2008). /// A 64-bit floating point type (specifically, the "binary64" type defined in IEEE 754-2008).
/// ///
/// This type is very similar to [`f32`], but has increased /// This type is very similar to [`prim@f32`], but has increased precision by using twice as many
/// precision by using twice as many bits. Please see [the documentation for /// bits. Please see [the documentation for `f32`](prim@f32) or [Wikipedia on double-precision
/// `f32`][`f32`] or [Wikipedia on double precision
/// values][wikipedia] for more information. /// values][wikipedia] for more information.
/// ///
/// *[See also the `std::f64::consts` module](crate::f64::consts).* /// *[See also the `std::f64::consts` module](crate::f64::consts).*
/// ///
/// [`f32`]: prim@f32
/// [wikipedia]: https://en.wikipedia.org/wiki/Double-precision_floating-point_format /// [wikipedia]: https://en.wikipedia.org/wiki/Double-precision_floating-point_format
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
mod prim_f64 {} mod prim_f64 {}
@ -1313,12 +1311,12 @@ mod prim_f64 {}
/// A 128-bit floating point type (specifically, the "binary128" type defined in IEEE 754-2008). /// A 128-bit floating point type (specifically, the "binary128" type defined in IEEE 754-2008).
/// ///
/// This type is very similar to [`prim@f32`] and [`prim@f64`], but has increased precision by using twice /// This type is very similar to [`prim@f32`] and [`prim@f64`], but has increased precision by using twice
/// as many bits as `f64`. Please see [the documentation for [`prim@f32`] or [Wikipedia on /// as many bits as `f64`. Please see [the documentation for `f32`](prim@f32) or [Wikipedia on
/// quad-precision values][wikipedia] for more information. /// quad-precision values][wikipedia] for more information.
/// ///
/// Note that no platforms have hardware support for `f128` without enabling target specific features, /// Note that no platforms have hardware support for `f128` without enabling target specific features,
/// as for all instruction set architectures `f128` is considered an optional feature. /// as for all instruction set architectures `f128` is considered an optional feature.
/// Only Power ISA ("PowerPC") and RISCV specify it, and only certain microarchitectures /// Only Power ISA ("PowerPC") and RISC-V specify it, and only certain microarchitectures
/// actually implement it. For x86-64 and AArch64, ISA support is not even specified, /// actually implement it. For x86-64 and AArch64, ISA support is not even specified,
/// so it will always be a software implementation significantly slower than `f64`. /// so it will always be a software implementation significantly slower than `f64`.
/// ///