diff --git a/satrs-core/src/pool.rs b/satrs-core/src/pool.rs index 39b0fe5..e34db43 100644 --- a/satrs-core/src/pool.rs +++ b/satrs-core/src/pool.rs @@ -252,7 +252,7 @@ pub trait PoolProvider { } pub trait PoolProviderWithGuards: PoolProvider { - /// This function behaves like [PoolProviderMemInPlace::read], but consumes the provided address + /// This function behaves like [PoolProvider::read], but consumes the provided address /// and returns a RAII conformant guard object. /// /// Unless the guard [PoolRwGuard::release] method is called, the data for the @@ -262,7 +262,7 @@ pub trait PoolProviderWithGuards: PoolProvider { /// manual deletion is necessary when returning from a processing function prematurely. fn read_with_guard(&mut self, addr: StoreAddr) -> PoolGuard; - /// This function behaves like [PoolProviderMemInPlace::modify], but consumes the provided + /// This function behaves like [PoolProvider::modify], but consumes the provided /// address and returns a RAII conformant guard object. /// /// Unless the guard [PoolRwGuard::release] method is called, the data for the diff --git a/satrs-core/src/pus/scheduler.rs b/satrs-core/src/pus/scheduler.rs index cda1cc5..b05dca8 100644 --- a/satrs-core/src/pus/scheduler.rs +++ b/satrs-core/src/pus/scheduler.rs @@ -376,7 +376,7 @@ pub mod alloc_mod { /// This is the core data structure for scheduling PUS telecommands with [alloc] support. /// /// It is assumed that the actual telecommand data is stored in a separate TC pool offering - /// a [crate::pool::PoolProviderMemInPlace] API. This data structure just tracks the store + /// a [crate::pool::PoolProvider] API. This data structure just tracks the store /// addresses and their release times and offers a convenient API to insert and release /// telecommands and perform other functionality specified by the ECSS standard in section 6.11. /// The time is tracked as a [spacepackets::time::UnixTimestamp] but the only requirement to @@ -695,10 +695,12 @@ pub mod alloc_mod { self.release_telecommands_internal(releaser, tc_store, Some(tc_buf)) } - /// This functions is almost identical to [release_telecommands] but does not require - /// a user provided TC buffer because it will always use the [PoolProvider::read_as_vec] - /// API to read the TC packets. However, this will also perform frequent allocations - /// for all telecommands being released. + /// This functions is almost identical to [Self::release_telecommands_with_buffer] but does + /// not require a user provided TC buffer because it will always use the + /// [PoolProvider::read_as_vec] API to read the TC packets. + /// + /// However, this might also perform frequent allocations for all telecommands being + /// released. pub fn release_telecommands bool>( &mut self, releaser: R,