diff --git a/src/consts.rs b/src/consts.rs index 513c970..7eba726 100644 --- a/src/consts.rs +++ b/src/consts.rs @@ -14,7 +14,7 @@ // . /*! -This module contains constants. +Mathematical constants. The constants have the maximum precision possible for a fixed-point number, and are rounded down at that precision. diff --git a/src/lib.rs b/src/lib.rs index f490508..a9bcb1f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -287,12 +287,12 @@ use core::{ mem, }; -/// A prelude for users of the *fixed* crate. +/// A prelude to import useful traits. /// -/// This prelude is similar to the [standard library’s -/// prelude][prelude] in that you’ll almost always want to import its -/// entire contents, but unlike the standard library’s prelude you’ll -/// have to do so manually: +/// This prelude is similar to the +/// [standard library’s prelude][prelude] in that you’ll almost always +/// want to import its entire contents, but unlike the standard +/// library’s prelude you’ll have to do so manually: /// /// ``` /// # #[allow(unused_imports)] diff --git a/src/traits.rs b/src/traits.rs index 81dd4cd..df0182e 100644 --- a/src/traits.rs +++ b/src/traits.rs @@ -14,7 +14,7 @@ // . /*! -This module contains traits. +Traits for conversions and for generic use of fixed-point numbers. */ use crate::{ diff --git a/src/types/mod.rs b/src/types/mod.rs index 4fc7e04..1cd04a8 100644 --- a/src/types/mod.rs +++ b/src/types/mod.rs @@ -14,8 +14,7 @@ // . /*! -This module provides type aliases for all supported fixed-point -numbers. +Type aliases for all supported fixed-point numbers. */ use crate::{