Skip to content

Commit 12f8649

Browse files
Prefix all lines of the doc-comment for toUnfoldableUnordered with |
The full comment is particularly interesting for toUnfoldableUnordered because it explains the difference to toUnfoldable.
1 parent 81bf0db commit 12f8649

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/Data/Map/Internal.purs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -586,12 +586,12 @@ toUnfoldable m = unfoldr go (m : Nil) where
586586
go $ left : singleton k1 v1 : mid : singleton k2 v2 : right : tl
587587

588588
-- | Convert a map to an unfoldable structure of key/value pairs
589-
--
590-
-- While this traversal is up to 10% faster in benchmarks than `toUnfoldable`,
591-
-- it leaks the underlying map stucture, making it only suitable for applications
592-
-- where order is irrelevant.
593-
--
594-
-- If you are unsure, use `toUnfoldable`
589+
-- |
590+
-- | While this traversal is up to 10% faster in benchmarks than `toUnfoldable`,
591+
-- | it leaks the underlying map stucture, making it only suitable for applications
592+
-- | where order is irrelevant.
593+
-- |
594+
-- | If you are unsure, use `toUnfoldable`
595595
toUnfoldableUnordered :: forall f k v. Unfoldable f => Map k v -> f (Tuple k v)
596596
toUnfoldableUnordered m = unfoldr go (m : Nil) where
597597
go Nil = Nothing

0 commit comments

Comments
 (0)