From 2ef7302a1c307b1ed12cfe873ad89fb52ad6c13c Mon Sep 17 00:00:00 2001 From: rzmk Date: Thu, 21 Sep 2023 08:14:06 -0400 Subject: [PATCH] docs: clarify using positive integer instead of number --- README.md | 6 +++--- ladderz/src/lib.rs | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1f68085..88b30d4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ The `ladderz` project is a collection of implementations of mathematical/technic ### 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: @@ -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 ``` -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 ./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)] ``` -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 diff --git a/ladderz/src/lib.rs b/ladderz/src/lib.rs index df29bf1..7624a5d 100644 --- a/ladderz/src/lib.rs +++ b/ladderz/src/lib.rs @@ -6,7 +6,7 @@ //! //! # 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. //! //! First let's create a new Rust project and change into the project directory: @@ -67,7 +67,7 @@ //! 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 //! ./target/release/my_ladderz_project 12 @@ -86,7 +86,7 @@ //! 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. pub mod pre_algebra;