Rendering of exceptions by napoleon. #4046
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This lets napoleon render exceptions using the standard info field syntax ``` :raises FooException: Some condition. ``` rather than the nonstandard ``` :raises: :exc:`FooException` -- Some condition. ``` Note that the previous approach was more forgiving if an explanatory text was given in the Raises section without an actual exception class: ``` Raises ------ If something occurs. ``` would be rendered as ``` :raises: *If something occurs* ``` which is OK-ish but is now rendered as ``` :raises If something occurs.: ``` which is somewhat more nonsensical. However neither the Google style guide nor numpydoc actually support this form (they always have both the type and the description) so I think the change is reasonable.
RobRuana
approved these changes
Sep 23, 2018
|
Only a year late! |
|
Better late than never :p |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This lets napoleon render exceptions using the standard info field
syntax
rather than the nonstandard
Note that the previous approach was more forgiving if an explanatory
text was given in the Raises section without an actual exception class:
would be rendered as
which is OK-ish but is now rendered as
which is somewhat more nonsensical.
However neither the Google style guide nor numpydoc actually support
this form (they always have both the type and the description) so I
think the change is reasonable.
attn @RobRuana xpost #3735
Feel free to reuse code in this PR if you want to make a configurable version as discussed in #3735.
Subject: See above
Feature or Bugfix
Purpose
Detail
Relates
(looks like the type linter does not like certain constructs, meh :-()