improve first line of module docs
This commit is contained in:
parent
eebb76e7b0
commit
f23ddc6616
|
@ -14,7 +14,7 @@
|
|||
// <https://opensource.org/licenses/MIT>.
|
||||
|
||||
/*!
|
||||
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.
|
||||
|
|
10
src/lib.rs
10
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)]
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
// <https://opensource.org/licenses/MIT>.
|
||||
|
||||
/*!
|
||||
This module contains traits.
|
||||
Traits for conversions and for generic use of fixed-point numbers.
|
||||
*/
|
||||
|
||||
use crate::{
|
||||
|
|
|
@ -14,8 +14,7 @@
|
|||
// <https://opensource.org/licenses/MIT>.
|
||||
|
||||
/*!
|
||||
This module provides type aliases for all supported fixed-point
|
||||
numbers.
|
||||
Type aliases for all supported fixed-point numbers.
|
||||
*/
|
||||
|
||||
use crate::{
|
||||
|
|
Loading…
Reference in New Issue