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 #8597: autodoc: metadata only docstring is treated as undocumented #9158

Merged
merged 2 commits into from May 3, 2021

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented May 2, 2021

Feature or Bugfix

  • Bugfix

Purpose

…ndocumented

The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
@tk0miya tk0miya merged commit 38758db into sphinx-doc:4.x May 3, 2021
@tk0miya tk0miya deleted the 8597_metadata_only_docstring branch May 3, 2021 13:26
@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

Successfully merging this pull request may close these issues.

None yet

1 participant