Skip to content

Commit 3a67aa0

Browse files
committed
add alloc feature change to readme and changelog
1 parent 43be98d commit 3a67aa0

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1313
parameter `E`)
1414
- removed the default error of `try_[pin_]init!`, now you always have to specify an error using
1515
`? Error` at the end
16+
- put `InPlaceInit` behind the `alloc` feature flag, this allows stable usage of the `#![no_std]`
17+
part of the crate
1618

1719
## [0.0.7] - 2024-04-09
1820

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ it into it's final memory location.
2626

2727
This library allows you to do in-place initialization safely.
2828

29-
## Nightly only
29+
### Nightly Needed for `alloc` and `std` features
3030

31-
This library requires unstable features and thus can only be used with a nightly compiler.
32-
The internally used features are:
31+
This library requires unstable features when the `alloc` or `std` features are enabled and thus
32+
can only be used with a nightly compiler. The internally used features are:
3333
- `allocator_api`
34-
- `new_uninit` (only if the `alloc` or `std` features are enabled)
35-
- `get_mut_unchecked` (only if the `alloc` or `std` features are enabled)
34+
- `new_uninit`
35+
- `get_mut_unchecked`
3636

37-
The user will be required to activate these features:
37+
When enabling the `alloc` or `std` feature, the user will be required to activate these features:
3838
- `allocator_api`
3939

4040
## Overview

src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@
1818
//!
1919
//! This library allows you to do in-place initialization safely.
2020
//!
21-
//! # Nightly only
21+
//! ## Nightly Needed for `alloc` and `std` features
2222
//!
23-
//! This library requires unstable features and thus can only be used with a nightly compiler.
24-
//! The internally used features are:
23+
//! This library requires unstable features when the `alloc` or `std` features are enabled and thus
24+
//! can only be used with a nightly compiler. The internally used features are:
2525
//! - `allocator_api`
26-
//! - `new_uninit` (only if the `alloc` or `std` features are enabled)
27-
//! - `get_mut_unchecked` (only if the `alloc` or `std` features are enabled)
26+
//! - `new_uninit`
27+
//! - `get_mut_unchecked`
2828
//!
29-
//! The user will be required to activate these features:
29+
//! When enabling the `alloc` or `std` feature, the user will be required to activate these features:
3030
//! - `allocator_api`
3131
//!
3232
//! # Overview

0 commit comments

Comments
 (0)