fix: honor attr metadata privacy (swev-id: sphinx-doc__sphinx-8593)#67
Open
casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-8593from
Open
fix: honor attr metadata privacy (swev-id: sphinx-doc__sphinx-8593)#67casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-8593from
casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-8593from
Conversation
Author
Local Validation
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Documenter.filter_members()to merge attribute doc-comment metadata into privacy checks:meta public:and:meta private:from either docstring or comment consistently while keeping existing naming fallback#: :meta public:are included by autodocReproduction Steps
tests/test_ext_autodoc_attr_metadata.pyfrom this change.PYTHONPATH=/workspace/sphinx .venv/bin/pytest tests/test_ext_autodoc_attr_metadata.py -qon the original branch.Observed Failure
Fix
ModuleAnalyzer.find_attr_docs()and fold their metadata into the existing privacy decision, treating:meta private:as dominant if present and:meta public:as opt-in otherwise.Verification
.venv/bin/flake8 tests/test_ext_autodoc_attr_metadata.pymicromamba run -p /workspace/.micromamba/envs/py38 env PYTHONPATH=/workspace/sphinx pytest -qResolves #60