From 90bc8d5d5c62e5a3e1507fecbe9c2e25f4a1b7d5 Mon Sep 17 00:00:00 2001
From: Ronno Das <ronnodas@gmail.com>
Date: Fri, 20 Sep 2024 07:45:34 +0200
Subject: [PATCH] doc for added trait

---
 src/combinations.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/combinations.rs b/src/combinations.rs
index f5aa4630e..f2f84279c 100644
--- 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;