Adjust BiSignalDefault doc to clarify affects simulation only (#2720)…

… (#2799) (cherry picked from commit 280905d) Co-authored-by: Lucas Bollen <lucas@qbaylogic.com>
clash-lang · Aug 26, 2024 · a1c2f9c · a1c2f9c
1 parent 1dcede3
commit a1c2f9c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/clash-prelude/src/Clash/Signal/BiSignal.hs b/clash-prelude/src/Clash/Signal/BiSignal.hs
@@ -133,8 +133,8 @@ import           GHC.TypeLits               (KnownNat, Nat)
 import           GHC.Stack                  (HasCallStack)
 import           Data.Reflection            (Given (..))
 
--- | Used to specify the /default/ behavior of a \"BiSignal\", i.e. what value is
--- read when no value is being written to it.
+-- | Used to specify the /default/ behavior of a \"BiSignal\" in Haskell simulation, i.e.
+-- what value is read when no value is being written to it.
 data BiSignalDefault
   = PullUp
   -- ^ __inout__ port behaves as if connected to a pull-up resistor