Documentation for kademliaSample api.

1 files changed, 3 insertions, 1 deletions

diff --git a/kad/src/Network/Kademlia/Routing.hs b/kad/src/Network/Kademlia/Routing.hs
index c7fdf028..8412e789 100644
--- a/kad/src/Network/Kademlia/Routing.hs
+++ b/kad/src/Network/Kademlia/Routing.hs
@@ -798,7 +798,9 @@ data KademliaSpace nid ni = KademliaSpace
     , kademliaTestBit :: nid -> Word -> Bool
       -- | The Kademlia xor-metric.
     , kademliaXor :: nid -> nid -> nid
-
+      -- | Generate random node.  Given a way to generate a random bytestring
+      -- of some length, the "self" node-id, and a tuple as output by
+      -- 'bucketRange', it supplies a new random node-id.
     , kademliaSample :: forall m. Applicative m => (Int -> m BS.ByteString) -> nid -> (Int,Word8,Word8) -> m nid
     }