Skip to content

Commit 779e608

Browse files
authored
Merge pull request #581 from zeenix/fix-docs
Minor fixes to `pool` docs
2 parents 2db8844 + dab4430 commit 779e608

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1212
- `bytes::BufMut` is now implemented on `VecInner`.
1313
- Removed generic from `history_buf::OldestOrdered`.
1414
- Made `LenType` opt-in.
15+
- Minor fixes to `pool::boxed` docs.
1516

1617
### Fixed
1718

src/pool.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//!
77
//! - ARM architectures which instruction set include the LDREX, CLREX and STREX instructions, e.g.
88
//! `thumbv7m-none-eabi` but not `thumbv6m-none-eabi`
9-
//! - 32-bit x86, e.g. `i686-unknown-linux-gnu`
9+
//! - 32-bit and 64-bit x86.
1010
//!
1111
//! # Benchmarks
1212
//!

src/pool/boxed.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
//! # Example usage
44
//!
55
//! ```
6+
//! use core::ptr::addr_of_mut;
67
//! use heapless::{box_pool, pool::boxed::{Box, BoxBlock}};
78
//!
89
//! box_pool!(MyBoxPool: u128);
@@ -70,7 +71,7 @@
7071
//! #[allow(clippy::declare_interior_mutable_const)]
7172
//! const BLOCK: BoxBlock<u128> = BoxBlock::new(); // <=
7273
//! static mut BLOCKS: [BoxBlock<u128>; POOL_CAPACITY] = [BLOCK; POOL_CAPACITY];
73-
//! unsafe { addr_of_mut!(BLOCK).as_mut().unwrap()S }
74+
//! unsafe { addr_of_mut!(BLOCKS).as_mut().unwrap() }
7475
//! };
7576
//!
7677
//! for block in blocks {

0 commit comments

Comments
 (0)