Skip to content

Commit

Permalink
publish v0.1.1 after fixing some docs issues
Browse files Browse the repository at this point in the history
  • Loading branch information
root committed Mar 30, 2024
1 parent 0629b7c commit abeadad
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# 31 March 2024

V0.1.1

* Fix some issues with the documentations of `pconst!`, `nconst!`, `tnconst!` and `uconst!`.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "typenum-consts"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
authors = ["Jim Chng <jim.chng@outlook.com>"]
exclude = [
Expand Down
10 changes: 5 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
Expand Down Expand Up @@ -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:
///
Expand Down Expand Up @@ -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.
///
Expand Down Expand Up @@ -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.
///
Expand Down

0 comments on commit abeadad

Please sign in to comment.