rzmk/ladderz
1
0
Fork 0
mirror of https://github.com/rzmk/ladderz.git synced 2025-12-19 06:59:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: clarify using positive integer instead of number

Browse source
This commit is contained in:
rzmk 2023-09-21 08:14:06 -04:00
parent 3673f6df8e
commit 2ef7302a1c
No known key found for this signature in database
2 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -13,7 +13,7 @@ The `ladderz` project is a collection of implementations of mathematical/technic
### Usage ### Usage
Here's an example of using the `ladderz` crate to get the factors and factor pairs of a number in sorted order. Here's an example of using the `ladderz` crate to get the factors and factor pairs of a positive integer in sorted order.
First let's create a new Rust project and change into the project directory: First let's create a new Rust project and change into the project directory:
@ -73,7 +73,7 @@ Now let's build the project's binary file so we can run it from the command line
cargo build --release cargo build --release
``` ```
Our runnable binary file should be located at the local path `./target/release/my_ladders_project` (or `./target/release/my_ladders_project.exe` for Windows). Let's run it with the number `12` as input: Our runnable binary file should be located at the local path `./target/release/my_ladders_project` (or `./target/release/my_ladders_project.exe` for Windows). Let's run it with the positive integer `12` as input:
```bash ```bash
./target/release/my_ladderz_project 12 ./target/release/my_ladderz_project 12
@ -92,7 +92,7 @@ List of factors of 12: [1, 2, 3, 4, 6, 12]
List of factor pairs of 12: [(1, 12), (2, 6), (3, 4)] List of factor pairs of 12: [(1, 12), (2, 6), (3, 4)]
``` ```
Great! We've successfully used the `ladderz` crate to get the factors and factor pairs of a number in sorted order. Great! We've successfully used the `ladderz` crate to get the factors and factor pairs of a positive integer in sorted order.
## Ideas ## Ideas

6
ladderz/src/lib.rs
View file

@ -6,7 +6,7 @@
//! //!
//! # Example //! # Example
//! //!
//! Here's an example of using the `ladderz` crate to get the factors and factor pairs of a number in sorted order. //! Here's an example of using the `ladderz` crate to get the factors and factor pairs of a positive integer in sorted order.
//! We'll assume you're using Bash as your terminal. //! We'll assume you're using Bash as your terminal.
//! //!
//! First let's create a new Rust project and change into the project directory: //! First let's create a new Rust project and change into the project directory:
@ -67,7 +67,7 @@
//! cargo build --release //! cargo build --release
//! ``` //! ```
//! //!
//! Our runnable binary file should be located at the local path `./target/release/my_ladders_project` (or `./target/release/my_ladders_project.exe` for Windows). Let's run it with the number `12` as input: //! Our runnable binary file should be located at the local path `./target/release/my_ladders_project` (or `./target/release/my_ladders_project.exe` for Windows). Let's run it with the positive integer `12` as input:
//! //!
//! ```bash //! ```bash
//! ./target/release/my_ladderz_project 12 //! ./target/release/my_ladderz_project 12
@ -86,7 +86,7 @@
//! List of factor pairs of 12: [(1, 12), (2, 6), (3, 4)] //! List of factor pairs of 12: [(1, 12), (2, 6), (3, 4)]
//! ``` //! ```
//! //!
//! Great! We've successfully used the `ladderz` crate to get the factors and factor pairs of a number in sorted order. //! Great! We've successfully used the `ladderz` crate to get the factors and factor pairs of a positive integer in sorted order.
/// Various pre-algebra implementations including factor pairs, factors, multiples, and more. /// Various pre-algebra implementations including factor pairs, factors, multiples, and more.
pub mod pre_algebra; pub mod pre_algebra;