Improve error messages for see also parsing #306
Merged
+18
−32
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.
I ran into some exceptions raised while parsing improperly-formatted
See Also
entries and found the error messages difficult to understand. Currently, numpydoc raises a customParseError
exception that includes the entire docstring in the error message. Also, due to the way these errors from an extension are being handled by sphinx, the type of the exception is lost when reported. An example of one of these error messages is below:This PR makes two changes to improve these error messages:
ParseError
exception, which includes the entire docstring in the message, to the internal_error_location
method, which includes only the object name and file location (if_obj
exists)._error_location
to improve readability:_obj.__name__
, which eliminates the printing of addressesThe above exception message now looks like: