From e178d4aa62bbc228fcaedb6a880dd88d746789fe Mon Sep 17 00:00:00 2001 From: Sebastian Nagel Date: Fri, 5 Apr 2024 10:11:15 +0200 Subject: [PATCH] Add a haddock to mkVar --- .../src/Test/QuickCheck/StateModel/Variables.hs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/quickcheck-dynamic/src/Test/QuickCheck/StateModel/Variables.hs b/quickcheck-dynamic/src/Test/QuickCheck/StateModel/Variables.hs index f2cb825..620c98f 100644 --- a/quickcheck-dynamic/src/Test/QuickCheck/StateModel/Variables.hs +++ b/quickcheck-dynamic/src/Test/QuickCheck/StateModel/Variables.hs @@ -37,6 +37,10 @@ import Test.QuickCheck as QC newtype Var a = Var Int deriving (Eq, Ord, Typeable, Data) +-- | Create a fresh symbolic variable with given identifier. While 'Var's are +-- usually created by action generators, this function can be used for example +-- to create a 'Var' in the 'initialState' of a 'StateModel'. A good default +-- value for the identifier is '-1' as this will not be generated otherwise. mkVar :: Int -> Var a mkVar = Var