refactor: Deprecate no_docstring argument for Documenter.add_content()
#8589
Conversation
This file contains 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
Deprecate `no_docstring` argument for `Documenter.add_content()` again. At the first trial (sphinx-doc#8533), it changes the behavior of `autodoc-process-docstring` event; it is emitted unexpectedly for an alias of class. But it brings an incompatible change to extensions. Hence it was partially reverted at sphinx-doc#8581. This keeps not calling the event for an alias of class. To do that, now `Documenter.get_doc()` can return None value.
tk0miya
force-pushed
the
8581_deprecate_no_docstrings
branch
from
dbf6f14
to
6c645e4
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Feature or Bugfix
Purpose
no_docstringargument forDocumenter.add_content()again.no_docstringargument for Documenter.add_content() #8533), it changes the behavior ofautodoc-process-docstringevent; it is emitted unexpectedly for analias of class. But it brings an incompatible change to extensions.
Hence it was partially reverted at Fix #8566: autodoc-process-docstring is emitted to the alias classes #8581.
now
Documenter.get_doc()can return None value.