Fix AttributeError in underline length check #363
Merged
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.
Fixes gh-362.
The
NumpyDocString
class raises aUserWarning
during docstring parsing when the underline length doesn't match the header length. In an attempt to make thisUserWarning
more informative, some introspection is performed to try to get the name and location of the object. This introspection relied on the assumption that the object would have a__name__
attribute, which is not always the case, e.g. when_obj
is an instance of a user-definedCallable
.This PR fixes the issue by only reporting the improved UserWarning message when the introspection is successful.