Skip to content

Commit b416499

Browse files
committed
Add haddocks to UserProvidedEnv type and constructors
1 parent 89acb0a commit b416499

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

  • cardano-testnet/src/Testnet/Property

cardano-testnet/src/Testnet/Property/Run.hs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@ import qualified Test.Tasty.Hedgehog as H
4747
import Test.Tasty.Providers (testPassed)
4848
import Test.Tasty.Runners (Result (resultShortDescription), TestTree)
4949

50+
-- | Whether the user has provided the path to an existing testnet environment
51+
-- through the @--node-env@ flag, or not. This determines whether the testnet
52+
-- will reuse an existing environment or whether a new one should be created.
5053
data UserProvidedEnv
5154
= NoUserProvidedEnv
55+
-- ^ No user-provided environment, a new environment will be created for the user.
5256
| UserProvidedEnv FilePath
57+
-- ^ The user provided the path to an existing testnet environment through the @--node-env@ flag.
5358

5459
runTestnet :: UserProvidedEnv -> (Conf -> H.Integration TestnetRuntime) -> IO ()
5560
runTestnet env tn = do

0 commit comments

Comments
 (0)