Improve Cardano.Testnet with haddocks and reduce what is exported

Author: Jimbo4350

cardano-testnet/app/cardano-testnet.hs

@@ -4,8 +4,8 @@ import           Control.Monad
 import           Data.Function
 import           Data.Semigroup
 import           Options.Applicative
-import           System.IO (IO)
 import           Parsers
+import           System.IO (IO)
 
 main :: IO ()
 main = join $ customExecParser

cardano-testnet/src/Cardano/Testnet.hs

@@ -1,64 +1,48 @@
-module Cardano.Testnet
-  ( Babbage.BabbageTestnetOptions(..)
-  , Cardano.CardanoTestnetOptions(..)
-  , Shelley.ShelleyTestnetOptions(..)  
-  , TestnetOptions(..)
-  , TestnetNodeOptions(..)
-  , babbageDefaultTestnetOptions
-  , cardanoDefaultTestnetOptions
-  , cardanoDefaultTestnetNodeOptions  
-  , shelleyDefaultTestnetOptions
-  , testnet
+-- | This module provides a library interface for initiating a local testnet
+--
+module Cardano.Testnet (
+  -- * Testnets
 
-  , Conf(..)
-  , ProjectBase(..)
-  , YamlFilePath(..)
-  , mkConf
-  
-  , execCli
-  , execCli'
-  , execCli_
-  , procNode
-  , procChairman
-  
-  , getRelevantLeaderSlots
+  -- ** Start a testnet
+  testnet,
 
-  , assertByDeadlineMCustom
-  , integration
-  , isLinux
-  , waitUntilEpoch
+  -- ** Testnet options
+  TestnetOptions(..),
+  CardanoTestnetOptions(..),
+  BabbageTestnetOptions(..),
+  ShelleyTestnetOptions(..),
+  TestnetNodeOptions(..),
+  cardanoDefaultTestnetOptions,
+  babbageDefaultTestnetOptions,
+  shelleyDefaultTestnetOptions,
+  cardanoDefaultTestnetNodeOptions,
 
-  , disabled
-  , ignoreOnWindows
-  , ignoreOnMacAndWindows
+  -- * Configuration
+  Conf(..),
+  ProjectBase(..),
+  YamlFilePath(..),
+  mkConf,
 
-  , LeadershipSlot(..)
-  , NodeLoggingFormat(..)
-  , PaymentKeyPair(..)
-  , StakingKeyPair(..)
-  , TestnetRuntime(..)
-  , NodeRuntime(..)
-  , PoolNode(..)
-  , PoolNodeKeys(..)
-  , Delegator(..)
-  , allNodes
-  , bftSprockets
-  , poolSprockets
-  , poolNodeStdout
-  , readNodeLoggingFormat
-  , startNode
+  -- * Processes
+  procChairman,
+
+  -- * Utils
+  integration,
+  waitUntilEpoch,
+
+  -- * Runtime
+  NodeRuntime(..),
+  allNodes,
 
   ) where
 
 import           Testnet
-import           Testnet.Babbage as Babbage
-import           Testnet.Cardano as Cardano
+import           Testnet.Babbage
+import           Testnet.Cardano
+import           Testnet.Conf hiding (base)
 import           Testnet.Shelley as Shelley
 import           Testnet.Utils (waitUntilEpoch)
-import           Testnet.Conf hiding (base)
 
-import           Util.Assert
-import           Util.Base (integration, isLinux)
-import           Util.Ignore (disabled, ignoreOnWindows, ignoreOnMacAndWindows)
-import           Util.Process (assertByDeadlineMCustom, execCli, execCli', execCli_, procChairman, procNode)
+import           Util.Base (integration)
+import           Util.Process (procChairman)
 import           Util.Runtime