diff --git a/README.md b/README.md index 6ee83015b..d8be39be6 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,9 @@ There exist features `all` to enable all stable features, `all-unstable` to enab - **`hex`** - Fast hex encoder and decoder for both upper hex and lower hex - **`lazy-wrap`** - Wrappers around a lazily initialised value, and its initialisation function, supporting usage in static variables - **`nominal`** - Generic newtype wrappers, for increased type safety through Rust's nominal type system -- **`rand`** - More random number generators and utilities +- **`rand`** - Random number generators and utilities - **`with-cloned`** - Convenience macro for the clone-and-move pattern (yes, we're calling it that :p) -- **`z85`** - Fast encoder and decoder for [ZeroMQ](https://zeromq.org)'s [zZ85](https://rfc.zeromq.org/spec/32) format +- **`z85`** - Fast encoder and decoder for [ZeroMQ](https://zeromq.org)'s [Z85](https://rfc.zeromq.org/spec/32) format ### Addon features @@ -49,10 +49,10 @@ reminder: **Unstable features are NOT covered by semver!** - **`aoc`** - Utilities specific for writing solutions for [Advent of Code](https://adventofcode.com) - **`auth`** - Lower-level(ish) utilities for writing an authentication system, in which the client password is never sent over the wire - **`bitstream`** - Encoder and decoder for a stream of bits -- **`chainer`** - Wrappers around common structs that provide chaining APIs (take ownership, do operation, then return back) +- **`chainer`** - Wrappers around common structs that provide chaining APIs (take ownership, do operation, then return ownership back with the new value) - **`cli`** - CLI arguments parser - **`defer`** - Defer running code until the end of the current scope or until something gets dropped -- **`id`** - ID generators, of various output sizes, and guarantees of uniqueness and ordering +- **`id`** - ID generators that guarantee uniqueness and ordering, and of various output sizes - **`int`** - Bigints (ex. u384) and uneven sized ints (ex. u15) - **`iter`** - Iterator utilities - **`lsl`** - Experimental lib to help with writing Second Life scripts in Rust... because yes, I got fed up with it very quickly and immediately missed Rust lol diff --git a/scripts/src/bin/gen-features.rs b/scripts/src/bin/gen-features.rs index 93dcb904d..9044f9ab5 100644 --- a/scripts/src/bin/gen-features.rs +++ b/scripts/src/bin/gen-features.rs @@ -56,7 +56,7 @@ fn main() { #[unstable] "chainer" - "Wrappers around common structs that provide chaining APIs (take ownership, do operation, then return back)" + "Wrappers around common structs that provide chaining APIs (take ownership, do operation, then return ownership back with the new value)" #[unstable] "cli" @@ -93,7 +93,7 @@ fn main() { #[unstable] "id" - "ID generators, of various output sizes, and guarantees of uniqueness and ordering" + "ID generators that guarantee uniqueness and ordering, and of various output sizes" features: ["export-all-submodules", "num-traits", "rand"] #[unstable] @@ -153,7 +153,7 @@ fn main() { "UTF-8 only path manipulation utilities written from scratch" "rand" - "More random number generators and utilities" + "Random number generators and utilities" dependencies: ["rand", "rand-chacha"] #[unstable] @@ -192,7 +192,7 @@ fn main() { "Convenience macro for the clone-and-move pattern (yes, we're calling it that :p)" "z85" - "Fast encoder and decoder for [ZeroMQ](https://zeromq.org)'s [zZ85](https://rfc.zeromq.org/spec/32) format" + "Fast encoder and decoder for [ZeroMQ](https://zeromq.org)'s [Z85](https://rfc.zeromq.org/spec/32) format" dependencies: ["thiserror"] features: ["num-traits"] diff --git a/src/lib.rs b/src/lib.rs index 06496497b..99cb7d04b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -175,7 +175,7 @@ pub mod bitstream; #[cfg(feature = "chainer-unstable")] #[cfg_attr(docsrs, doc(cfg(feature = "chainer-unstable")))] -/// Wrappers around common structs that provide chaining APIs (take ownership, do operation, then return back) +/// Wrappers around common structs that provide chaining APIs (take ownership, do operation, then return ownership back with the new value) #[doc = ""] #[doc = include_str!("./chainer/README.md")] pub mod chainer; @@ -231,7 +231,7 @@ pub mod hex; #[cfg(feature = "id-unstable")] #[cfg_attr(docsrs, doc(cfg(feature = "id-unstable")))] -/// ID generators, of various output sizes, and guarantees of uniqueness and ordering +/// ID generators that guarantee uniqueness and ordering, and of various output sizes #[doc = ""] #[doc = include_str!("./id/README.md")] pub mod id; @@ -308,7 +308,7 @@ pub mod path; #[cfg(feature = "rand")] #[cfg_attr(docsrs, doc(cfg(feature = "rand")))] -/// More random number generators and utilities +/// Random number generators and utilities #[doc = ""] #[doc = include_str!("./rand/README.md")] pub mod rand; @@ -364,7 +364,7 @@ pub mod with_cloned; #[cfg(feature = "z85")] #[cfg_attr(docsrs, doc(cfg(feature = "z85")))] -/// Fast encoder and decoder for [ZeroMQ](https://zeromq.org)'s [zZ85](https://rfc.zeromq.org/spec/32) format +/// Fast encoder and decoder for [ZeroMQ](https://zeromq.org)'s [Z85](https://rfc.zeromq.org/spec/32) format #[doc = ""] #[doc = include_str!("./z85/README.md")] pub mod z85;