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

Close #6830: autodoc: consider a member private if docstring contains :private: #6979

Merged
merged 1 commit into from Jan 11, 2020

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jan 1, 2020

Feature or Bugfix

  • Feature

Purpose

@tk0miya tk0miya added type:enhancement enhance or introduce a new feature domains:py labels Jan 1, 2020
@tk0miya tk0miya added this to the 2.4.0 milestone Jan 1, 2020
doc/extdev/appapi.rst Show resolved Hide resolved
doc/extdev/appapi.rst Outdated Show resolved Hide resolved
doc/usage/restructuredtext/domains.rst Outdated Show resolved Hide resolved
sphinx/ext/autodoc/__init__.py Outdated Show resolved Hide resolved
@tk0miya
Copy link
Member Author

tk0miya commented Jan 3, 2020

Side note: I thought adding :private: on the top of docstring at first. But I noticed it conflicts with autodoc_docstring_signature feature. So I chose info-field-list to specify its attribute finally.

Copy link
Member

@shimizukawa shimizukawa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tk0miya tk0miya merged commit f169560 into sphinx-doc:master Jan 11, 2020
@tk0miya tk0miya deleted the 6830_autodoc_private branch January 11, 2020 06:14
@tk0miya
Copy link
Member Author

tk0miya commented Jan 11, 2020

Thank you for reviewing. merged!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
domains:py type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants