IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Close #6830: autodoc: consider a member private if docstring has "private" metadata

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-01-01 14:40:13 +09:00
parent 0319faf8f1
commit b968bb91e9
11 changed files with 176 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
tests/test_util_docstrings.py
View File

@@ -8,7 +8,34 @@
:license: BSD, see LICENSE for details.
"""
from sphinx.util.docstrings import prepare_docstring, prepare_commentdoc
from sphinx.util.docstrings import (
extract_metadata, prepare_docstring, prepare_commentdoc
)
def test_extract_metadata():
metadata = extract_metadata(":meta foo: bar\n"
":meta baz:\n")
assert metadata == {'foo': 'bar', 'baz': ''}
# field_list like text following just after paragaph is not a field_list
metadata = extract_metadata("blah blah blah\n"
":meta foo: bar\n"
":meta baz:\n")
assert metadata == {}
# field_list like text following after blank line is a field_list
metadata = extract_metadata("blah blah blah\n"
"\n"
":meta foo: bar\n"
":meta baz:\n")
assert metadata == {'foo': 'bar', 'baz': ''}
# non field_list item breaks field_list
metadata = extract_metadata(":meta foo: bar\n"
"blah blah blah\n"
":meta baz:\n")
assert metadata == {'foo': 'bar'}
def test_prepare_docstring():