diff --git a/Cargo.toml b/Cargo.toml index 56f2e84..777e87e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "multi-trait" -version = "1.0.3" +version = "1.0.4" edition = "2024" rust-version = "1.85" authors = ["Dave Grantham "] diff --git a/SECURITY.md b/SECURITY.md index aa152ef..8f70335 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## Overview -The `multitrait` crate provides foundational traits for encoding and decoding multiformats types using unsigned varint encoding. This document outlines the security properties, threat model, and guarantees of this crate. +The `multi-trait` crate provides foundational traits for encoding and decoding multiformats types using unsigned varint encoding. This document outlines the security properties, threat model, and guarantees of this crate. ## Security Properties diff --git a/examples/basic.rs b/examples/basic.rs index d674f6f..3ade862 100644 --- a/examples/basic.rs +++ b/examples/basic.rs @@ -1,7 +1,7 @@ // SPDX-License-Identifier: Apache-2.0 //! Basic encoding and decoding example //! -//! This example demonstrates the core functionality of the multitrait crate: +//! This example demonstrates the core functionality of the multi-trait crate: //! - Encoding values to bytes #![allow(clippy::unreadable_literal)] //! - Decoding bytes back to values diff --git a/examples/custom_type.rs b/examples/custom_type.rs index e2b6cca..af8db69 100644 --- a/examples/custom_type.rs +++ b/examples/custom_type.rs @@ -1,7 +1,7 @@ // SPDX-License-Identifier: Apache-2.0 //! Custom type implementation example //! -//! This example demonstrates how to implement multitrait traits for your +//! This example demonstrates how to implement multi-trait traits for your //! custom types, including: #![allow( clippy::items_after_statements, diff --git a/examples/error_handling.rs b/examples/error_handling.rs index 61ed6b6..20b3177 100644 --- a/examples/error_handling.rs +++ b/examples/error_handling.rs @@ -2,7 +2,7 @@ //! Error handling example //! //! This example demonstrates proper error handling patterns when using -//! the multitrait crate, including: +//! the multi-trait crate, including: //! - Handling decode errors //! - Inspecting error sources //! - Validating data with `EncodedBytes` @@ -209,7 +209,7 @@ fn inspect_error_source() { println!(); } -/// Helper function showing how to wrap multitrait errors in application-specific errors +/// Helper function showing how to wrap multi-trait errors in application-specific errors #[allow(dead_code)] mod application_errors { use multi_trait::Error as MultitraitError; diff --git a/examples/no_std.rs b/examples/no_std.rs index 9d6f761..53d3a03 100644 --- a/examples/no_std.rs +++ b/examples/no_std.rs @@ -1,17 +1,17 @@ // SPDX-License-Identifier: Apache-2.0 //! `no_std` usage example //! -//! This example demonstrates how to use the multitrait crate in a `no_std` +//! This example demonstrates how to use the multi-trait crate in a `no_std` //! environment. While this example file runs with std (since examples require it), #![allow(clippy::items_after_statements, clippy::unreadable_literal)] //! it shows the patterns you would use in actual `no_std` code. //! -//! To use multitrait in a `no_std` environment: +//! To use multi-trait in a `no_std` environment: //! //! 1. In your Cargo.toml: //! ```toml //! [dependencies] -//! multitrait = { version = "1.0", default-features = false } +//! multi-trait = { version = "1.0", default-features = false } //! ``` //! //! 2. In your code: diff --git a/src/lib.rs b/src/lib.rs index 7d2a591..32b16eb 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -262,7 +262,7 @@ //! //! ```toml //! [dependencies] -//! multitrait = { version = "1.0", default-features = false } +//! multi-trait = { version = "1.0", default-features = false } //! ``` //! //! ## Implementation Details