summaryrefslogtreecommitdiff
path: root/libraries/base/Data/Either.hs
diff options
context:
space:
mode:
authorross <unknown>2003-09-05 15:06:48 +0000
committerross <unknown>2003-09-05 15:06:48 +0000
commitda79ff34aa61cb85bb30f0c20ff9d0fc9e162297 (patch)
tree43f4ea312c5d73a7a699d65e53a24d07ab8b5adf /libraries/base/Data/Either.hs
parentc4723c7fd5dba00975046f225ae74f6462b485b6 (diff)
downloadhaskell-da79ff34aa61cb85bb30f0c20ff9d0fc9e162297.tar.gz
[project @ 2003-09-05 15:06:48 by ross]
doc tweaks
Diffstat (limited to 'libraries/base/Data/Either.hs')
-rw-r--r--libraries/base/Data/Either.hs3
1 files changed, 3 insertions, 0 deletions
diff --git a/libraries/base/Data/Either.hs b/libraries/base/Data/Either.hs
index 406e7e7e3b..65b366123d 100644
--- a/libraries/base/Data/Either.hs
+++ b/libraries/base/Data/Either.hs
@@ -35,6 +35,9 @@ hold a correct value (mnemonic: \"right\" also means \"correct\").
-}
data Either a b = Left a | Right b deriving (Eq, Ord )
+-- | Case analysis for the 'Either' type.
+-- If the value is @'Left' a@, apply the first function to @a@;
+-- if it is @'Right' b@, apply the second function to @b@.
either :: (a -> c) -> (b -> c) -> Either a b -> c
either f _ (Left x) = f x
either _ g (Right y) = g y