diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..38f7301 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,5 @@ +# 31 March 2024 + +V0.1.1 + +* Fix some issues with the documentations of `pconst!`, `nconst!`, `tnconst!` and `uconst!`. diff --git a/Cargo.lock b/Cargo.lock index c09ccfa..af0cda9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -201,7 +201,7 @@ checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825" [[package]] name = "typenum-consts" -version = "0.1.0" +version = "0.1.1" dependencies = [ "dotenv", "peekmore", diff --git a/Cargo.toml b/Cargo.toml index 4035573..d57a703 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "typenum-consts" -version = "0.1.0" +version = "0.1.1" edition = "2021" authors = ["Jim Chng "] exclude = [ diff --git a/src/lib.rs b/src/lib.rs index c0fbbf8..82623eb 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -23,7 +23,7 @@ mod tnconst_impl; mod uconst_impl; mod vendors; -/// [`uconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level unsigned integer (i.e. the type implements the [`typenum::Unsigned`] trait). +/// [`uconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level unsigned integer (i.e. the type that implements the [`typenum::Unsigned`] trait). /// /// There are three ways you can invoke this macro. /// @@ -121,9 +121,9 @@ pub fn uconst(items: TokenStream) -> TokenStream { } } -/// [`tnconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level unsigned/positive/negative (depending on what is the prefix-sign) integer (i.e. the type implements the [`typenum::Unsigned`]/[`typenum::Integer`] trait). +/// [`tnconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level unsigned/positive/negative (depending on what is the prefix-sign) integer (i.e. the type that implements the [`typenum::Unsigned`]/[`typenum::Integer`] trait). /// -/// Because [`tnconst!`] can be evaluated into [`typenum::UInt`], [`typenum::PInt`] and [`typenum::NInt`], to disambiguate them, one is required to invoke the macro with either `+`, `-` to get [`tnconst!`] to evaluate the macro input as [`typenum::PInt`] or [`typenum::NInt`], respectively. [`typenum::NInt`] is the default and does not require any sign to be prefixed. +/// Because [`tnconst!`] can be evaluated into [`typenum::UInt`], [`typenum::PInt`] and [`typenum::NInt`], to disambiguate them, one is required to invoke the macro with either `+`, `-` to get [`tnconst!`] to evaluate the macro input as [`typenum::PInt`] or [`typenum::NInt`], respectively. [`typenum::UInt`] is the default and does not require any sign to be prefixed. /// /// Examples: /// @@ -217,7 +217,7 @@ pub fn tnconst(items: TokenStream) -> TokenStream { } } -/// [`pconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level positive integer (i.e. the type implements the [`typenum::Integer`] trait). +/// [`pconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level positive integer (i.e. the type that implements the [`typenum::Integer`] trait). /// /// There are three ways you can invoke this macro. /// @@ -315,7 +315,7 @@ pub fn pconst(items: TokenStream) -> TokenStream { } } -/// [`nconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level negative integer (i.e. the type implements the [`typenum::Integer`] trait). +/// [`nconst!`] is a procedural macro that converts a literal integer or an expression into a [`typenum`]'s type-level negative integer (i.e. the type that implements the [`typenum::Integer`] trait). /// /// There are three ways you can invoke this macro. ///