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

autodoc: a docsting having metadata only should be treated as undocumented #8597

Closed
tk0miya opened this issue Dec 27, 2020 · 0 comments
Closed

Comments

@tk0miya
Copy link
Member

tk0miya commented Dec 27, 2020

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.

Expected behavior
They should be shown only if :undoc-members: option given.

Your project
No

Screenshots
No

Environment info

  • OS: Mac
  • Python version: 3.9.1
  • Sphinx version: HEAD of 3.x
  • Sphinx extensions: sphinx.ext.autodoc
  • Extra tools: No

Additional context
No

@tk0miya tk0miya added this to the 3.5.0 milestone Dec 27, 2020
@tk0miya tk0miya modified the milestones: 3.5.0, 4.0.0 Feb 14, 2021
@tk0miya tk0miya modified the milestones: 4.0.0, 4.1.0 Apr 17, 2021
tk0miya added a commit to tk0miya/sphinx that referenced this issue May 2, 2021
@tk0miya tk0miya closed this as completed in 469def5 May 3, 2021
tk0miya added a commit that referenced this issue May 3, 2021
Fix #8597: autodoc: metadata only docstring is treated as undocumented
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant