Skip to content

Commit 65af25c

Browse files
committed
Bring back docs on alterF
1 parent 1a643e6 commit 65af25c

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Data/HashMap/Internal.hs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,6 +1347,11 @@ alter' f !h0 !k0 = go_alter' h0 k0 0
13471347
Just v' -> runST $ two s h k v' hy t
13481348
{-# INLINE alter' #-}
13491349

1350+
-- | \(O(\log n)\) The expression @('alterF' f k map)@ alters the value @x@ at
1351+
-- @k@, or absence thereof.
1352+
--
1353+
-- 'alterF' can be used to insert, delete, or update a value in a map.
1354+
--
13501355
-- Note: 'alterF' is a flipped version of the 'at' combinator from
13511356
-- <https://hackage.haskell.org/package/lens/docs/Control-Lens-At.html#v:at Control.Lens.At>.
13521357
--

0 commit comments

Comments
 (0)