Skip to content

Improve documentation for Map functions with bounds params #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve documentation for Map functions with bounds params #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions src/Data/Map/Internal.purs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,10 +365,9 @@ findMin = case _ of
Leaf -> Just { key: k, value: v }
_ -> findMin l

-- | Fold over the entries of a given map where the key is between a lower and
-- | an upper bound. Passing `Nothing` as either the lower or upper bound
-- | argument means that the fold has no lower or upper bound, i.e. the fold
-- | starts from (or ends with) the smallest (or largest) key in the map.
-- | Fold over the entries of a given map that have keys within a lower and
-- | upper bound (including keys equal to those bounds). `Nothing` is treated as
-- | unbounded.
-- |
-- | ```purescript
-- | foldSubmap (Just 1) (Just 2) (\_ v -> [v])
Expand Down Expand Up @@ -420,10 +419,9 @@ foldSubmapBy appendFn memptyValue kmin kmax f =
in
go

-- | Returns a new map containing all entries of the given map which lie
-- | between a given lower and upper bound, treating `Nothing` as no bound i.e.
-- | including the smallest (or largest) key in the map, no matter how small
-- | (or large) it is. For example:
-- | Returns a new map containing all entries with keys that fall within a
-- | specified lower and upper bound (including keys equal to those bounds).
-- | `Nothing` is treated as unbounded.
-- |
-- | ```purescript
-- | submap (Just 1) (Just 2)
Expand Down