Permalink
Browse files

changed haddocks to reference preview

  • Loading branch information...
1 parent 7a1f322 commit 856772c7764e1fd0408608c8b48b567466e2a5c0 @ekmett committed Dec 7, 2012
Showing with 1 addition and 2 deletions.
  1. +1 −2 src/Control/Lens/Fold.hs
View
@@ -766,14 +766,13 @@ headOf l = getFirst# (foldMapOf l (first# Just))
{-# INLINE headOf #-}
{-# DEPRECATED headOf "`headOf' will be removed in 3.8. (Use `preview' or `firstOf')" #-}
-
-- | Perform a safe 'head' of a 'Fold' or 'Control.Lens.Traversal.Traversal' or retrieve 'Just' the result
-- from a 'Getter' or 'Lens'.
--
-- When using a 'Control.Lens.Traversal.Traversal' as a partial 'Control.Lens.Type.Lens', or a 'Fold' as a partial 'Getter' this can be a convenient
-- way to extract the optional value.
--
--- @('^?') ≡ 'flip' 'headOf'@
+-- @('^?') ≡ 'flip' 'preview'@
--
-- @
-- ('^?') :: s -> 'Getter' s a -> 'Maybe' a

0 comments on commit 856772c

Please sign in to comment.