Add top-level documentation for module RoundRobin.

cardano-foundation · Jan 18, 2021 · c59cc78 · c59cc78
1 parent 2752000
commit c59cc78
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/core/src/Cardano/Wallet/Primitive/CoinSelection/MA/RoundRobin.hs b/lib/core/src/Cardano/Wallet/Primitive/CoinSelection/MA/RoundRobin.hs
@@ -5,6 +5,16 @@
 {-# LANGUAGE OverloadedLabels #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 
+-- |
+-- Copyright: © 2021 IOHK
+-- License: Apache-2.0
+--
+-- Provides an implementation of the Random-Round-Robin coin selection
+-- algorithm for multi-asset UTxO sets.
+--
+-- See documentation for the 'performSelection' function for more details on
+-- how to perform a selection.
+--
 module Cardano.Wallet.Primitive.CoinSelection.MA.RoundRobin
     (
     -- * Performing a selection