Add doc to (<$>) explaining its relationship to ($)
authorChris Martin <ch.martin@gmail.com>
Fri, 11 Mar 2016 09:40:16 +0000 (10:40 +0100)
committerBen Gamari <ben@smart-cactus.org>
Fri, 11 Mar 2016 12:20:19 +0000 (13:20 +0100)
Reviewers: bgamari, hvr, austin

Reviewed By: bgamari

Subscribers: thomie

Differential Revision: https://phabricator.haskell.org/D1989

libraries/base/Data/Functor.hs

index 72ee965..8eba29e 100644 (file)
@@ -33,6 +33,15 @@ infixl 4 <$>
 
 -- | An infix synonym for 'fmap'.
 --
+-- The name of this operator is an allusion to '$'.
+-- Note the similarities between their types:
+--
+-- >  ($)  ::              (a -> b) ->   a ->   b
+-- > (<$>) :: Functor f => (a -> b) -> f a -> f b
+--
+-- Whereas '$' is function application, '<$>' is function
+-- application lifted over a 'Functor'.
+--
 -- ==== __Examples__
 --
 -- Convert from a @'Maybe' 'Int'@ to a @'Maybe' 'String'@ using 'show':