Added documentation for base.WrappedException (#24200)

add a docstring for WrappedException
JuliaLang · Nov 22, 2017 · b18ff77 · b18ff77
1 parent 80d8719
commit b18ff77
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/base/boot.jl b/base/boot.jl
@@ -260,8 +260,6 @@ struct AssertionError <: Exception
 end
 AssertionError() = AssertionError("")
 
-#Generic wrapping of arbitrary exceptions
-#Subtypes should put the exception in an 'error' field
 abstract type WrappedException <: Exception end
 
 struct LoadError <: WrappedException

diff --git a/base/docs/basedocs.jl b/base/docs/basedocs.jl
@@ -857,6 +857,15 @@ Generic error type. The error message, in the `.msg` field, may provide more spe
 """
 ErrorException
 
+"""
+    WrappedException(msg)
+
+Generic type for `Exception`s wrapping another `Exception`, such as `LoadError` and
+`InitError`. Those exceptions contain information about the the root cause of an
+exception. Subtypes define a field `error` containing the causing `Exception`.
+"""
+Core.WrappedException
+
 """
     UndefRefError()