[commit: packages/containers] cleaned_bugfix394, master, merge-doc-target, merge-fixes-5.9, merge-restrict-fix-5.8, revert-408-bugfix_394: Fix documentation formatting (860be17)

git at git.haskell.org git at git.haskell.org
Mon Apr 17 21:45:11 UTC 2017


Repository : ssh://git@git.haskell.org/containers

On branches: cleaned_bugfix394,master,merge-doc-target,merge-fixes-5.9,merge-restrict-fix-5.8,revert-408-bugfix_394
Link       : http://git.haskell.org/packages/containers.git/commitdiff/860be17647b836d8a74f714bb3518dc3958755b0

>---------------------------------------------------------------

commit 860be17647b836d8a74f714bb3518dc3958755b0
Author: David Feuer <David.Feuer at gmail.com>
Date:   Wed Aug 31 00:58:58 2016 -0400

    Fix documentation formatting


>---------------------------------------------------------------

860be17647b836d8a74f714bb3518dc3958755b0
 Data/Map/Base.hs            |  2 +-
 Data/Map/Strict/Internal.hs |  2 +-
 Data/Sequence/Base.hs       | 11 +++++++----
 3 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/Data/Map/Base.hs b/Data/Map/Base.hs
index c31a576..6020b51 100644
--- a/Data/Map/Base.hs
+++ b/Data/Map/Base.hs
@@ -1124,7 +1124,7 @@ data AreWeStrict = Strict | Lazy
 
 -- | /O(log n)/. The expression (@'alterF' f k map@) alters the value @x@ at
 -- @k@, or absence thereof.  'alterF' can be used to inspect, insert, delete,
--- or update a value in a 'Map'.  In short : @'lookup' k <$> 'alterF' f k m = f
+-- or update a value in a 'Map'.  In short: @'lookup' k \<$\> 'alterF' f k m = f
 -- ('lookup' k m)@.
 --
 -- Example:
diff --git a/Data/Map/Strict/Internal.hs b/Data/Map/Strict/Internal.hs
index 0b0a34e..08cadcb 100644
--- a/Data/Map/Strict/Internal.hs
+++ b/Data/Map/Strict/Internal.hs
@@ -804,7 +804,7 @@ alter = go
 
 -- | /O(log n)/. The expression (@'alterF' f k map@) alters the value @x@ at @k@, or absence thereof.
 -- 'alterF' can be used to inspect, insert, delete, or update a value in a 'Map'.
--- In short : @'lookup' k <$> 'alterF' f k m = f ('lookup' k m)@.
+-- In short: @'lookup' k \<$\> 'alterF' f k m = f ('lookup' k m)@.
 --
 -- Example:
 --
diff --git a/Data/Sequence/Base.hs b/Data/Sequence/Base.hs
index 103fe89..c79bd6c 100644
--- a/Data/Sequence/Base.hs
+++ b/Data/Sequence/Base.hs
@@ -663,10 +663,13 @@ thin12 s pr m (Three a b c) = DeepTh s pr (thin $ m `snocTree` node2 a b) (One12
 thin12 s pr m (Four a b c d) = DeepTh s pr (thin $ m `snocTree` node2 a b) (Two12 c d)
 
 -- | Intersperse an element between the elements of a sequence.
--- > intersperse a empty = empty
--- > intersperse a (singleton x) = singleton x
--- > intersperse a (fromList [x,y]) = fromList [x,a,y]
--- > intersperse a (fromList [x,y,z]) = fromList [x,a,y,a,z]
+--
+-- @
+-- intersperse a empty = empty
+-- intersperse a (singleton x) = singleton x
+-- intersperse a (fromList [x,y]) = fromList [x,a,y]
+-- intersperse a (fromList [x,y,z]) = fromList [x,a,y,a,z]
+-- @
 --
 -- @since 0.5.8
 intersperse :: a -> Seq a -> Seq a



More information about the ghc-commits mailing list