WalletRestorationInfo comments.

Author: matt-noonan

wallet-new/src/Cardano/Wallet/Kernel/Internal.hs

@@ -48,11 +48,22 @@ import           Cardano.Wallet.Kernel.Types (WalletId)
   Restoration status
 -------------------------------------------------------------------------------}
 
+-- | Wallet restoration information
+--
+-- The restoration info tracks the progress of a background wallet
+-- restoration task currently in progress. In addition to giving
+-- visibility into a restoration task, it also provides an action
+-- that can be used to cancel the background restoration task.
 data WalletRestorationInfo = WalletRestorationInfo
   { _wriCurrentSlot :: FlatSlotId
+     -- ^ The most recently restored slot
   , _wriTargetSlot  :: FlatSlotId
+     -- ^ The target slot; when restoration reaches this slot,
+     -- it is finished and the wallet is up-to-date.
   , _wriThroughput  :: MeasuredIn 'BlocksPerSecond BlockCount
+    -- ^ Speed of restoration.
   , _wriCancel      :: IO ()
+    -- ^ The action that can be used to cancel the restoration task.
   }
 
 {-------------------------------------------------------------------------------