Update ErrorCall documentation for the location argument
authorÖmer Sinan Ağacan <omeragacan@gmail.com>
Mon, 6 Nov 2017 20:35:08 +0000 (15:35 -0500)
committerBen Gamari <ben@smart-cactus.org>
Mon, 6 Nov 2017 20:35:09 +0000 (15:35 -0500)
Reviewers: hvr, bgamari

Reviewed By: bgamari

Subscribers: rwbarton, thomie

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

libraries/base/GHC/Exception.hs

index 725b864..d3a6745 100644 (file)
@@ -167,8 +167,8 @@ instance Exception SomeException where
 throw :: Exception e => e -> a
 throw e = raise# (toException e)
 
--- |This is thrown when the user calls 'error'. The @String@ is the
--- argument given to 'error'.
+-- | This is thrown when the user calls 'error'. The first @String@ is the
+-- argument given to 'error', second @String@ is the location.
 data ErrorCall = ErrorCallWithLocation String String
     deriving (Eq, Ord)