Fix Documentation Typos (#545)
authorFrank Steffahn <fdsteffahn@gmail.com>
Sat, 10 Mar 2018 04:12:06 +0000 (05:12 +0100)
committerDavid Feuer <David.Feuer@gmail.com>
Sat, 10 Mar 2018 04:12:06 +0000 (23:12 -0500)
In the Haddocks, fix a bunch of infix functions with unescaped backticks that got formatted all wrong.

Data/IntMap/Internal.hs
Data/IntSet/Internal.hs
Data/Map/Internal.hs
Data/Map/Strict/Internal.hs
Data/Sequence.hs
Data/Sequence/Internal.hs
Data/Set/Internal.hs

index 51ec47f..1bad02b 100644 (file)
@@ -1079,7 +1079,7 @@ differenceWithKey f m1 m2
 -- | /O(n+m)/. Remove all the keys in a given set from a map.
 --
 -- @
--- m `withoutKeys` s = 'filterWithKey' (\k _ -> k `'IntSet.notMember'` s) m
+-- m \`withoutKeys\` s = 'filterWithKey' (\k _ -> k ``IntSet.notMember`` s) m
 -- @
 --
 -- @since 0.5.8
@@ -1157,7 +1157,7 @@ intersection m1 m2
 -- | /O(n+m)/. The restriction of a map to the keys in a set.
 --
 -- @
--- m `restrictKeys` s = 'filterWithKey' (\k _ -> k `'IntSet.member'` s) m
+-- m \`restrictKeys\` s = 'filterWithKey' (\k _ -> k ``IntSet.member`` s) m
 -- @
 --
 -- @since 0.5.8
index 0540e7a..8a0b08e 100644 (file)
@@ -643,7 +643,7 @@ subsetCmp Nil Nil = EQ
 subsetCmp Nil _   = LT
 
 -- | /O(n+m)/. Is this a subset?
--- @(s1 `isSubsetOf` s2)@ tells whether @s1@ is a subset of @s2@.
+-- @(s1 \`isSubsetOf\` s2)@ tells whether @s1@ is a subset of @s2@.
 
 isSubsetOf :: IntSet -> IntSet -> Bool
 isSubsetOf t1@(Bin p1 m1 l1 r1) (Bin p2 m2 l2 r2)
index 7d2ecd2..4506e1b 100644 (file)
@@ -1899,8 +1899,8 @@ difference t1 (Bin _ k _ l2 r2) = case split k t1 of
 -- | /O(m*log(n\/m + 1)), m <= n/. Remove all keys in a 'Set' from a 'Map'.
 --
 -- @
--- m `'withoutKeys'` s = 'filterWithKey' (\k _ -> k `'Set.notMember'` s) m
--- m `'withoutKeys'` s = m `'difference'` 'fromSet' (const ()) s
+-- m \`withoutKeys\` s = 'filterWithKey' (\k _ -> k ``Set.notMember`` s) m
+-- m \`withoutKeys\` s = m ``difference`` 'fromSet' (const ()) s
 -- @
 --
 -- @since 0.5.8
@@ -1981,8 +1981,8 @@ intersection t1@(Bin _ k x l1 r1) t2
 -- found in a 'Set'.
 --
 -- @
--- m `'restrictKeys'` s = 'filterWithKey' (\k _ -> k `'Set.member'` s) m
--- m `'restrictKeys'` s = m `'intersect' 'fromSet' (const ()) s
+-- m \`restrictKeys\` s = 'filterWithKey' (\k _ -> k ``Set.member`` s) m
+-- m \`restrictKeys\` s = m ``intersect`` 'fromSet' (const ()) s
 -- @
 --
 -- @since 0.5.8
index 3905e1e..756582b 100644 (file)
@@ -1379,7 +1379,7 @@ mapWithKey f (Bin sx kx x l r) =
 #endif
 
 -- | /O(n)/.
--- @'traverseWithKey' f m == 'fromList' <$> 'traverse' (\(k, v) -> (\v' -> v' `seq` (k,v')) <$> f k v) ('toList' m)@
+-- @'traverseWithKey' f m == 'fromList' <$> 'traverse' (\(k, v) -> (\v' -> v' \`seq\` (k,v')) <$> f k v) ('toList' m)@
 -- That is, it behaves much like a regular 'traverse' except that the traversing
 -- function also has access to the key associated with a value and the values are
 -- forced before they are installed in the result map.
index 863399b..3e4c705 100644 (file)
@@ -65,7 +65,7 @@
 --
 --     but
 --
---     @ (1 :<| undefined) \`index\` 0 = undefined @
+--     @ (1 :<| undefined) ``index`` 0 = undefined @
 --
 -- Sequences may also be compared to immutable
 -- [arrays](https://hackage.haskell.org/package/array)
index 9c811c5..b945b12 100644 (file)
@@ -4358,7 +4358,7 @@ instance MonadZip Seq where
 -- | Unzip a sequence of pairs.
 --
 -- @
--- unzip ps = ps `'seq'` ('fmap' 'fst' ps) ('fmap' 'snd' ps)
+-- unzip ps = ps ``seq`` ('fmap' 'fst' ps) ('fmap' 'snd' ps)
 -- @
 --
 -- Example:
index cd1bb2e..9f61716 100644 (file)
@@ -600,7 +600,7 @@ isProperSubsetOf s1 s2
 
 
 -- | /O(n+m)/. Is this a subset?
--- @(s1 `isSubsetOf` s2)@ tells whether @s1@ is a subset of @s2@.
+-- @(s1 \`isSubsetOf\` s2)@ tells whether @s1@ is a subset of @s2@.
 isSubsetOf :: Ord a => Set a -> Set a -> Bool
 isSubsetOf t1 t2
   = (size t1 <= size t2) && (isSubsetOfX t1 t2)
@@ -1691,7 +1691,7 @@ splitRoot orig =
 -- | Calculate the power set of a set: the set of all its subsets.
 --
 -- @
--- t `member` powerSet s == t `isSubsetOf` s
+-- t ``member`` powerSet s == t ``isSubsetOf`` s
 -- @
 --
 -- Example:
@@ -1746,7 +1746,7 @@ instance Monoid (MergeSet a) where
 
 -- | Calculate the disjoin union of two sets.
 --
--- @ disjointUnion xs ys = map Left xs `union` map Right ys @
+-- @ disjointUnion xs ys = map Left xs ``union`` map Right ys @
 --
 -- Example:
 --