doc for added trait

rust-itertools · Sep 20, 2024 · b5e5cd1 · b5e5cd1
1 parent 25a6413
commit b5e5cd1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/combinations.rs b/src/combinations.rs
@@ -39,6 +39,8 @@ pub struct CombinationsGeneric<I: Iterator, Idx> {
     first: bool,
 }
 
+/// A type holding indices of elements in a pool or buffer of items from an inner iterator
+/// and used to pick out different combinations in a generic way.
 pub trait PoolIndex<T>: BorrowMut<[usize]> {
     type Item;