doc for added trait

ronnodas · phimuemue · commit a447b6896043 · 2024-09-20T08:05:59.000Z
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;
 

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ pub struct CombinationsGeneric<I: Iterator, Idx> {`
`39`	`39`	`first: bool,`
`40`	`40`	`}`
`41`	`41`
	`42`	`+/// A type holding indices of elements in a pool or buffer of items from an inner iterator`
	`43`	`+/// and used to pick out different combinations in a generic way.`
`42`	`44`	`pub trait PoolIndex<T>: BorrowMut<[usize]> {`
`43`	`45`	`type Item;`
`44`	`46`