Documentation

Signed-off-by: GitHub <[email protected]>

Author: tdelmas

README.md

@@ -82,7 +82,7 @@ In that example:
 
 Most methods and traits available on the underlying type are available on the types of this crate.
 
-Most constants are also available, with the most appropriate `TypedFloat` type (except `NAN` for obvious reasons) in the [`tf64`] and [`tf32`] modules (in [`tf64::consts`] and [`tf32::consts`] respectively when the constant comes from [`core::f64::consts`] or [`core::f32::consts`]). Those modules are named that way to avoid conflicts or confusion with the primitives [`f32`] and [`f64`].
+Most constants are also available, with the most appropriate TypedFloat type (except `NAN` for obvious reasons) in the [`tf64`] and [`tf32`] modules (in [`tf64::consts`] and [`tf32::consts`] respectively when the constant comes from [`core::f64::consts`] or [`core::f32::consts`]). Those modules are named that way to avoid conflicts or confusion with the primitives [`f32`] and [`f64`].
 
 ⚠️ Like for primitives [`f32`] and [`f64`],`-0.0 == +0.0` is `true` for all types of this crate.
 To facilitate comparisons, the methods `is_positive_zero` and `is_negative_zero` are added.

typed_floats/src/lib.rs

@@ -1,7 +1,7 @@
 #![doc = include_str!("../README.truncated.md")]
 //! # Rules
 //!
-//! Conversions rules for operations are summarized in [`TypedFloat`].
+//! Conversions rules for operations are summarized in [`doc`].
 //!
 //! # Examples
 //!
@@ -127,7 +127,7 @@ pub use traits::*;
 pub use types::*;
 
 typed_floats_macros::generate_docs!(
-    pub trait TypedFloat {}
+    pub mod doc {}
 );
 
 /// This module contains constants from [`core::f64`], casted to the corresponding type

typed_floats/src/types/mod.rs

@@ -1,4 +1,4 @@
-/// An error that can occur when converting from a string into a `TypedFloat`
+/// An error that can occur when converting from a string into a TypedFloat
 #[derive(Debug)]
 pub enum FromStrError {
     /// The string did not contain a valid float number