[Git][ghc/ghc][master] base: Add haddocks to HasExceptionContext

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
c2e9c581 by Rodrigo Mesquita at 2024-08-01T00:49:18-04:00
base: Add haddocks to HasExceptionContext

Fixes #25091

- - - - -


1 changed file:

- libraries/ghc-internal/src/GHC/Internal/Exception/Type.hs


Changes:

=====================================
libraries/ghc-internal/src/GHC/Internal/Exception/Type.hs
=====================================
@@ -52,6 +52,19 @@ import GHC.Internal.Base
 import GHC.Internal.Show
 import GHC.Internal.Exception.Context
 
+{- |
+A constraint used to propagate 'ExceptionContext's.
+
+GHC will automatically default any unsolved 'HasExceptionContext' constraints to an
+empty exception context, similarly to 'HasCallStack'.
+
+NOTE: The fact that @HasExceptionContext@ is defined as an implicit parameter is
+an implementation detail and __should not__ be considered a part of the API.
+It does however mean that any implicit parameter `?exceptionContext :: ExceptionContext`
+will be subject to defaulting, as described above.
+
+ at since base-4.20.0.0
+-}
 type HasExceptionContext = (?exceptionContext :: ExceptionContext)
 
 {- |



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/c2e9c581f95f5af9b710d151459a9235604cb410

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/c2e9c581f95f5af9b710d151459a9235604cb410
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20240801/4ee0a286/attachment-0001.html>