Skip to content

Commit 1945da3

Browse files
committed
Fix haddock warnings
1 parent a281663 commit 1945da3

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

src/Data/Bit/F2Poly.hs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import GHC.Integer.Logarithms
5252
#endif
5353

5454
-- | Binary polynomials of one variable, backed
55-
-- by an unboxed 'Data.Vector.Unboxed.Vector' 'Bit'.
55+
-- by an unboxed 'Data.Vector.Unboxed.Vector' t'Bit'.
5656
--
5757
-- Polynomials are stored normalized, without leading zero coefficients.
5858
--
@@ -67,7 +67,7 @@ import GHC.Integer.Logarithms
6767
-- @since 1.0.1.0
6868
newtype F2Poly = F2Poly {
6969
unF2Poly :: U.Vector Bit
70-
-- ^ Convert an 'F2Poly' to a vector of coefficients
70+
-- ^ Convert an t'F2Poly' to a vector of coefficients
7171
-- (first element corresponds to a constant term).
7272
--
7373
-- >>> :set -XBinaryLiterals
@@ -78,7 +78,7 @@ newtype F2Poly = F2Poly {
7878
}
7979
deriving (Eq, Ord, Generic, NFData)
8080

81-
-- | Make an 'F2Poly' from a list of coefficients
81+
-- | Make an t'F2Poly' from a list of coefficients
8282
-- (first element corresponds to a constant term).
8383
--
8484
-- >>> :set -XOverloadedLists
@@ -105,7 +105,7 @@ one = F2Poly $ BitVec 0 1 $
105105
fromBigNat oneBigNat
106106
#endif
107107

108-
-- -- | A valid 'F2Poly' has offset 0 and no trailing garbage.
108+
-- -- | A valid t'F2Poly' has offset 0 and no trailing garbage.
109109
-- _isValid :: F2Poly -> Bool
110110
-- _isValid (F2Poly (BitVec o l arr)) = o == 0 && l == l'
111111
-- where
@@ -116,7 +116,7 @@ one = F2Poly $ BitVec 0 1 $
116116
-- 'abs' = 'id' and 'signum' = 'const' 1.
117117
--
118118
-- 'fromInteger' converts a binary polynomial, encoded as 'Integer',
119-
-- to 'F2Poly' encoding.
119+
-- to t'F2Poly' encoding.
120120
instance Num F2Poly where
121121
(+) = coerce xorBits
122122
(-) = coerce xorBits
@@ -164,7 +164,7 @@ instance Enum F2Poly where
164164
instance Real F2Poly where
165165
toRational = fromIntegral
166166

167-
-- | 'toInteger' converts a binary polynomial, encoded as 'F2Poly',
167+
-- | 'toInteger' converts a binary polynomial, encoded as t'F2Poly',
168168
-- to an 'Integer' encoding.
169169
instance Integral F2Poly where
170170
#ifdef MIN_VERSION_ghc_bignum

src/Data/Bit/Internal.hs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ import GHC.Exts
5454
-- | A newtype wrapper with a custom instance
5555
-- for "Data.Vector.Unboxed", which packs booleans
5656
-- as efficient as possible (8 values per byte).
57-
-- Unboxed vectors of `Bit` use 8x less memory
57+
-- Unboxed vectors of t'Bit' use 8x less memory
5858
-- than unboxed vectors of 'Bool' (which store one value per byte),
5959
-- but random writes are slightly slower.
6060
--
@@ -72,7 +72,7 @@ newtype Bit = Bit {
7272
-- | A newtype wrapper with a custom instance
7373
-- for "Data.Vector.Unboxed", which packs booleans
7474
-- as efficient as possible (8 values per byte).
75-
-- Unboxed vectors of `Bit` use 8x less memory
75+
-- Unboxed vectors of t'Bit' use 8x less memory
7676
-- than unboxed vectors of 'Bool' (which store one value per byte),
7777
-- but random writes are slightly slower.
7878
--
@@ -90,7 +90,7 @@ newtype Bit = Bit {
9090

9191
-- | There is only one lawful 'Num' instance possible
9292
-- with '+' = 'xor' and
93-
-- 'fromInteger' = 'Bit' . 'odd'.
93+
-- 'fromInteger' = v'Bit' . 'odd'.
9494
--
9595
-- @since 1.0.1.0
9696
instance Num Bit where

0 commit comments

Comments
 (0)