Add comments to constructors of SelectionFilter type.

cardano-foundation · Apr 5, 2022 · bc06ef9 · bc06ef9
1 parent 274a755
commit bc06ef9
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/core/src/Cardano/Wallet/Primitive/Types/UTxOIndex/Internal.hs b/lib/core/src/Cardano/Wallet/Primitive/Types/UTxOIndex/Internal.hs
@@ -394,9 +394,15 @@ disjoint i1 i2 = universe i1 `Map.disjoint` universe i2
 --
 data SelectionFilter asset
     = SelectSingleton asset
+      -- ^ Matches UTxOs that contain only the given asset and no other assets.
     | SelectPairWith asset
+      -- ^ Matches UTxOs that contain the given asset and exactly one other
+      -- asset.
     | SelectAnyWith asset
+      -- ^ Matches UTxOs that contain the given asset and any number of other
+      -- assets.
     | SelectAny
+      -- ^ Matches all UTxOs regardless of what assets they contain.
     deriving (Eq, Foldable, Functor, Show, Traversable)
 
 -- | Selects an entry at random from the index according to the given filter.