improve first line of module docs

This commit is contained in:
Trevor Spiteri 2020-05-08 00:51:56 +02:00
parent 5cb690a076
commit c762dadfbc
4 changed files with 8 additions and 9 deletions

View File

@ -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.

View File

@ -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 librarys
/// prelude][prelude] in that youll almost always want to import its
/// entire contents, but unlike the standard librarys prelude youll
/// have to do so manually:
/// This prelude is similar to the
/// [standard librarys prelude][prelude] in that youll almost always
/// want to import its entire contents, but unlike the standard
/// librarys prelude youll have to do so manually:
///
/// ```
/// # #[allow(unused_imports)]

View File

@ -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::{

View File

@ -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::{