1
Fork 0
mirror of https://github.com/RGBCube/uutils-coreutils synced 2025-07-29 12:07:46 +00:00

df: correct links in BlockSize documentation

This commit is contained in:
Jeffrey Finkelstein 2022-02-23 21:08:35 -05:00
parent d3ca49128d
commit 9f71b7ac7f

View file

@ -63,11 +63,12 @@ struct FsSelector {
/// A block size to use in condensing the display of a large number of bytes. /// A block size to use in condensing the display of a large number of bytes.
/// ///
/// The [`Bytes`] variant represents a static block size. The /// The [`BlockSize::Bytes`] variant represents a static block
/// [`HumanReadableDecimal`] and [`HumanReadableBinary`] variants /// size. The [`BlockSize::HumanReadableDecimal`] and
/// represent dynamic block sizes: as the number of bytes increases, /// [`BlockSize::HumanReadableBinary`] variants represent dynamic
/// the divisor increases as well (for example, from 1 to 1,000 to /// block sizes: as the number of bytes increases, the divisor
/// 1,000,000 and so on in the case of [`HumanReadableDecimal`]). /// increases as well (for example, from 1 to 1,000 to 1,000,000 and
/// so on in the case of [`BlockSize::HumanReadableDecimal`]).
/// ///
/// The default variant is `Bytes(1024)`. /// The default variant is `Bytes(1024)`.
enum BlockSize { enum BlockSize {
@ -79,13 +80,15 @@ enum BlockSize {
/// Use the largest divisor corresponding to a unit, like B, K, M, G, etc. /// Use the largest divisor corresponding to a unit, like B, K, M, G, etc.
/// ///
/// This variant represents powers of 1,000. Contrast with /// This variant represents powers of 1,000. Contrast with
/// [`HumanReadableBinary`], which represents powers of 1,024. /// [`BlockSize::HumanReadableBinary`], which represents powers of
/// 1,024.
HumanReadableDecimal, HumanReadableDecimal,
/// Use the largest divisor corresponding to a unit, like B, K, M, G, etc. /// Use the largest divisor corresponding to a unit, like B, K, M, G, etc.
/// ///
/// This variant represents powers of 1,000. Contrast with /// This variant represents powers of 1,024. Contrast with
/// [`HumanReadableBinary`], which represents powers of 1,024. /// [`BlockSize::HumanReadableDecimal`], which represents powers
/// of 1,000.
HumanReadableBinary, HumanReadableBinary,
} }