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

Fix regression in autodoc.Documenter.parse_name #11613

Merged
merged 4 commits into from Aug 20, 2023

Conversation

zmc
Copy link
Contributor

@zmc zmc commented Aug 17, 2023

If the assert statement added in #11523 fails, the build fails and the user only sees assert matched is not None; with this change, they will get a proper warning message containing the name of the offending module, and the build will succeed.

If the assert statement added in sphinx-doc#11523 fails, the build fails and the
user only sees `assert matched is not None`; with this change, they will
get a proper warning message containing the name of the offending
module, and the build will succeed.

Signed-off-by: Zack Cerza <zack@redhat.com>
@kamoltat
Copy link

Would love to review but it seems like I don't have the permission to do so

@AA-Turner
Copy link
Member

You should be able to review via the files tab? You don't need any permissions.

A

@kamoltat
Copy link

You should be able to review via the files tab? You don't need any permissions.

A

ahh I see

@AA-Turner AA-Turner changed the title Fix regression in autodoc.Documenter.parse_name Fix regression in autodoc.Documenter.parse_name Aug 20, 2023
@AA-Turner AA-Turner enabled auto-merge (squash) August 20, 2023 22:30
@AA-Turner AA-Turner linked an issue Aug 20, 2023 that may be closed by this pull request
@AA-Turner AA-Turner merged commit 1e16f21 into sphinx-doc:master Aug 20, 2023
27 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 20, 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.

sphinx.ext.autodoc (7.2.0+) fails with AssertionError
3 participants