Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ExceptionDocumenter.can_document_member nicer TypeError #11660

Merged
merged 5 commits into from
Aug 30, 2023
Merged

ExceptionDocumenter.can_document_member nicer TypeError #11660

merged 5 commits into from
Aug 30, 2023

Conversation

jamesbraza
Copy link
Contributor

Subject: re-throwing ExceptionDocumenter.can_document_member failure with better message

Feature or Bugfix

  • Feature

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 the member and membername for a nicer crash log and sped-up debugging.

Relates

@AA-Turner AA-Turner enabled auto-merge (squash) August 30, 2023 18:42
@AA-Turner AA-Turner merged commit 74329d9 into sphinx-doc:master Aug 30, 2023
@jamesbraza jamesbraza deleted the nice-ifying-typeerror-in-11654 branch August 30, 2023 19:14
@jamesbraza
Copy link
Contributor Author

Oh sorry for not knowing about needing to edit CHANGES, thanks for doing it for me, cheers!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Crash with TypeError: issubclass() arg 1 must be a class when running make html
2 participants