Skip to content

Commit

Permalink
doc: fix feature docs phrasing
Browse files Browse the repository at this point in the history
  • Loading branch information
bluurryy committed Nov 29, 2024
1 parent 5582871 commit 938cc1d
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ std = ["allocator-api2/std", "alloc"]
## Adds `Global` as the default base allocator, `BumpBox::into_box` and some interactions with `alloc` collections.
alloc = ["allocator-api2/alloc"]

## Adds functions and traits that will panic when allocations fails.
## Adds functions and traits that will panic when the allocation fails.
## Without this feature, allocation failures cannot cause panics, and only
## `try_`-prefixed allocation methods will be available.
panic-on-alloc = []
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ assert_eq!(bump.stats().allocated(), 4);
## Feature Flags
* **`std`** *(enabled by default)* — Adds `BumpPool` and implementations of `std::io` traits for `BumpBox` and vectors.
* **`alloc`** *(enabled by default)* — Adds `Global` as the default base allocator, `BumpBox::into_box` and some interactions with `alloc` collections.
* **`panic-on-alloc`** *(enabled by default)* — Adds functions and traits that will panic when allocations fails.
* **`panic-on-alloc`** *(enabled by default)* — Adds functions and traits that will panic when the allocation fails.
Without this feature, allocation failures cannot cause panics, and only
`try_`-prefixed allocation methods will be available.
* **`serde`** — Adds `Serialize` implementations for `BumpBox`, strings and vectors, and `DeserializeSeed` for strings and vectors.
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@
//! # Feature Flags
//! * **`std`** *(enabled by default)* — Adds `BumpPool` and implementations of `std::io` traits for `BumpBox` and vectors.
//! * **`alloc`** *(enabled by default)* — Adds `Global` as the default base allocator, `BumpBox::into_box` and some interactions with `alloc` collections.
//! * **`panic-on-alloc`** *(enabled by default)* — Adds functions and traits that will panic when allocations fails.
//! * **`panic-on-alloc`** *(enabled by default)* — Adds functions and traits that will panic when the allocation fails.
//! Without this feature, allocation failures cannot cause panics, and only
//! `try_`-prefixed allocation methods will be available.
//! * **`serde`** — Adds `Serialize` implementations for `BumpBox`, strings and vectors, and `DeserializeSeed` for strings and vectors.
Expand Down

0 comments on commit 938cc1d

Please sign in to comment.