Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for v0.2.1 #5

Merged
merged 2 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
[package]
name = "count-digits"
version = "0.2.0"
version = "0.2.1"
authors = ["Erik Nordin <[email protected]>"]
description = """
CountDigits is a trait for retrieving the count of decimal digits in an integer.
It is implemented for all of the primitive integer types as well as all of the
non-zero integer types.
"""
description = "A no-std trait to count the digits of integer types in various number bases."
homepage = "https://github.com/nordzilla/count-digits"
repository = "https://github.com/nordzilla/count-digits"
keywords = ["decimal", "digit", "count", "integer", "trait"]
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@

# count-digits

## CountDigits

A [no_std](https://docs.rust-embedded.org/book/intro/no-std.html) trait to count
the digits of an integer in various number bases.
the digits of integer types in various number bases.

Compatible with all primitive integer types and all non-zero integer types.

##### Examples
#### Examples
```rust
use count_digits::CountDigits;
use core::num::NonZeroIsize;
Expand All @@ -32,7 +30,7 @@ assert_eq!(
);
```

###### Note
##### Note

Be mindful with negative signed integers in non-decimal number bases.

Expand Down
8 changes: 3 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
#![cfg_attr(not(test), no_std)]
#![allow(clippy::zero_prefixed_literal)]
//! # CountDigits
//!
//! A [no_std](https://docs.rust-embedded.org/book/intro/no-std.html) trait to count
//! the digits of an integer in various number bases.
//! the digits of integer types in various number bases.
//!
//! Compatible with all primitive integer types and all non-zero integer types.
//!
//! #### Examples
//! ### Examples
//! ```rust
//! use count_digits::CountDigits;
//! use core::num::NonZeroIsize;
Expand All @@ -30,7 +28,7 @@
//! );
//! ```
//!
//! ##### Note
//! #### Note
//!
//! Be mindful with negative signed integers in non-decimal number bases.
//!
Expand Down
Loading