Enable strict-optional for several more modules#11523
Merged
AA-Turner merged 33 commits intosphinx-doc:masterfrom Jul 27, 2023
Merged
Enable strict-optional for several more modules#11523AA-Turner merged 33 commits intosphinx-doc:masterfrom
strict-optional for several more modules#11523AA-Turner merged 33 commits intosphinx-doc:masterfrom
Conversation
zmc
added a commit
to zmc/sphinx
that referenced
this pull request
Aug 17, 2023
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 <[email protected]>
AA-Turner
added a commit
that referenced
this pull request
Aug 20, 2023
If the assert statement added in GH-11523 fails, the build fails and the user only sees ``assert matched is not None``. With this change, the user gets a proper warning message containing the name of the offending module, and the build will succeed. Signed-off-by: Zack Cerza <[email protected]> Co-authored-by: Zack Cerza <[email protected]> Co-authored-by: Adam Turner <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
cc: @danieleades
This enables
strict-optionalmode for:sphinx.builders.htmlsphinx.builders.latexsphinx.domains.pythonsphinx.domains.stdsphinx.environmentsphinx.ext.apidocsphinx.ext.autodocsphinx.ext.autodoc.importersphinx.ext.autosummarysphinx.ext.autosummary.generatesphinx.ext.inheritance_diagramsphinx.ext.intersphinxsphinx.ext.imgmathsphinx.ext.mathjaxsphinx.ext.napoleon.docstringsphinx.registrysphinx.writers.latexA