Skip to content

Commit

Permalink
fix(docs): reword phrases
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewsonin committed May 21, 2024
1 parent 9d9515b commit 4ea95a6
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "blazemap"
version = "0.5.0"
version = "0.5.1"
authors = ["Andrew Sonin <sonin.cel@yandex.ru>"]
categories = ["data-structures", "concurrency"]
description = """
Expand Down
2 changes: 1 addition & 1 deletion src/loom.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use serde::{Serialize, Serializer};
use crate::traits::{BlazeMapId, TypeInfoContainer};

/// Provides `PartialOrd`, `Ord` and `Serialize` traits, which are derived as
/// for original type, for [`BlazeMapId`]s in the
/// for an original type, for [`BlazeMapId`]s in the
/// [`loom`](crate::external::loom) context.
#[derive(Debug, Copy, Clone)]
pub struct TestableId<'a, I, C> {
Expand Down
2 changes: 1 addition & 1 deletion src/type_info_containers/key_wrapper.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pub struct StaticContainer<K> {
}

/// Loom-testable version of the above container.
/// Note that it cannot be actually static
/// Note that it cannot be static
/// due to the [`loom` inability](https://github.com/tokio-rs/loom/issues/290)
/// to test statically initialized code.
#[cfg(loom)]
Expand Down
2 changes: 1 addition & 1 deletion src/type_info_containers/key_wrapper_bounded.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ pub struct StaticContainer<K, const CAP: usize> {
}

/// Loom-testable version of the above container.
/// Note that it cannot be actually static
/// Note that it cannot be static
/// due to the [`loom` inability](https://github.com/tokio-rs/loom/issues/290)
/// to test statically initialized code.
#[cfg(loom)]
Expand Down
4 changes: 2 additions & 2 deletions src/utils/offset_provider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use std::{hash::Hash, num::NonZeroUsize};
/// the [`define_key_wrapper`](crate::define_key_wrapper).
///
/// Publicity of the internal `usize` may lead to:
/// * UB if the programmer of the downstream crate would accidentally mutate it.
/// * UB if the programmer of the downstream crate accidentally mutates it.
/// * Incorrect auto-derives of standard traits such as `Default`, `Debug`,
/// `Display`, `PartialOrd`, `Ord`, `serde::Serialize` and
/// `serde::Deserialize`.
Expand Down Expand Up @@ -59,7 +59,7 @@ mod tests {

use crate::utils::offset_provider::OffsetProvider;

// These assertions are needed in order to prevent standard traits
// These assertions are needed to prevent standard traits
// from being automatically derived for types
// generated by the [`define_key_wrapper`](crate::define_plain_id) macro.
assert_not_impl_any!(OffsetProvider<usize>: Default, Debug, Display, PartialOrd);
Expand Down

0 comments on commit 4ea95a6

Please sign in to comment.