Added documentation for base.WrappedException #24200
Conversation
base/boot.jl
Outdated
| """ | ||
| WrappedException([msg]) | ||
|
|
||
| wrap arbitrary exceptions generically. |
There was a problem hiding this comment.
Proposal: Generic type for Exceptions 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 causingException.
|
Thanks for the PR! I think CI is failing because If you need any help, let me know here or on slack. 😄 |
taking doc for WrappedException out of boot.jl per @xorJane's suggestion.
|
Looks like the new location for the doc string was left out of this somehow. |
base/docs/basedocs.jl
Outdated
| `InitError`. Those exceptions contain information about the the root cause of an | ||
| exception. Subtypes define a field `error` containing the causing `Exception`. | ||
| """ | ||
| WrappedException |
There was a problem hiding this comment.
This should be Core.WrappedException and things will be alright :)
|
👍 |
add a docstring for WrappedException
PR related to #24043
Tried to base it off the documentation guide and used
DimensionMismatchexception doc as an example.Could possibly add additional info about
LoadErrorandInitErrorbut don't think this will be necessary