Skip to content

Commit

Permalink
fix: haddock in conditional compilation
Browse files Browse the repository at this point in the history
  • Loading branch information
MMZK1526 committed Nov 16, 2024
1 parent 9a9e2ac commit 19f412d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/Data/KindID/Class.hs
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,19 @@ class ToPrefix a where
instance ToPrefix (s :: Symbol) where
type PrefixSymbol s = s

#ifndef __HADDOCK_VERSION__
-- | A constraint for valid prefix 'Symbol's.
--
#ifndef __HADDOCK_VERSION__
type ValidPrefix prefix = ( KnownSymbol prefix
, LengthLT64C prefix
, IsLUSymbolC prefix )
#else
-- | A constraint for valid prefix 'Symbol's.
--
-- Note that this is __NOT__ the actual definition! Its true definition is
-- hidden here in the documentation as it uses internal type-level helpers that
-- we do not expose and make no guarantee on their In practice, any prefix with
-- this constraint is a valid prefix for a 'Data.KindID.KindID'.
-- we do not expose and make no guarantee on their stability. In practice, any
-- prefix with this constraint is a valid prefix for a 'Data.KindID.KindID'.
type ValidPrefix prefix = KnownSymbol prefix
#endif

Expand Down

0 comments on commit 19f412d

Please sign in to comment.