From ec3ef1bee555dc20cb2f5792ac5579b4b9f53b00 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 12 Feb 2024 11:11:50 +0100 Subject: [PATCH] docs --- satrs-core/src/pool.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/satrs-core/src/pool.rs b/satrs-core/src/pool.rs index f4ad22d..7db0914 100644 --- a/satrs-core/src/pool.rs +++ b/satrs-core/src/pool.rs @@ -363,8 +363,12 @@ mod alloc_mod { /// /// # Parameters /// - /// * `cfg`: Vector of tuples which represent a subpool. The first entry in the tuple specifies the - /// number of memory blocks in the subpool, the second entry the size of the blocks + /// * `cfg` - Vector of tuples which represent a subpool. The first entry in the tuple specifies + /// the number of memory blocks in the subpool, the second entry the size of the blocks + /// * `spill_to_higher_subpools` - Specifies whether data will be spilled to higher subpools + /// if the next fitting subpool is full. This is useful to ensure the pool remains useful + /// for all data sizes as long as possible, but it might also lead to frequently used + /// subpools which were not dimensioned properly chocking larger subpools. #[derive(Clone)] pub struct StaticPoolConfig { cfg: Vec<(NumBlocks, usize)>,