We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug autodoc: a docsting having metadata only should be treated as undocumented
To Reproduce
# example.py def _foo(): """:meta public:"""
# index.rst .. automodule:: example :members:
At present, _foo() is treated "having docstring". But its docstring does not contain any meaningful text.
_foo()
Expected behavior They should be shown only if :undoc-members: option given.
:undoc-members:
Your project No
Screenshots No
Environment info
Additional context No
The text was updated successfully, but these errors were encountered:
Fix sphinx-doc#8597: autodoc: metadata only docstring is treated as u…
bc06216
…ndocumented
469def5
Merge pull request #9158 from tk0miya/8597_metadata_only_docstring
38758db
Fix #8597: autodoc: metadata only docstring is treated as undocumented
No branches or pull requests
Describe the bug
autodoc: a docsting having metadata only should be treated as undocumented
To Reproduce
At present,
_foo()
is treated "having docstring". But its docstring does not contain any meaningful text.Expected behavior
They should be shown only if
:undoc-members:
option given.Your project
No
Screenshots
No
Environment info
Additional context
No
The text was updated successfully, but these errors were encountered: