ExceptionDocumenter.can_document_member
nicer TypeError
#11660
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.
Subject: re-throwing
ExceptionDocumenter.can_document_member
failure with better messageFeature or Bugfix
Purpose
The raw
TypeError
message leaves some questions unanswered (e.g. what aspect of my code failed?). Users then have to bisect their source code (or edit Sphinx installation) to find the violating piece. This PR adds printing of themember
andmembername
for a nicer crash log and sped-up debugging.Relates
TypeError: issubclass() arg 1 must be a class
when runningmake html
#11654