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

Fix missing commas after PEP-570 separators

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-02-24 02:03:15 +09:00
parent 0ae1bf6f03
commit 01eff916d1
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx/domains/python.py
View File

@ -72,12 +72,12 @@ def _parse_arglist(arglist: str) -> addnodes.desc_parameterlist:
for param in sig.parameters.values(): for param in sig.parameters.values():
if param.kind != param.POSITIONAL_ONLY and last_kind == param.POSITIONAL_ONLY: if param.kind != param.POSITIONAL_ONLY and last_kind == param.POSITIONAL_ONLY:
# PEP-570: Separator for Positional Only Parameter: / # PEP-570: Separator for Positional Only Parameter: /
params += nodes.Text('/') params += addnodes.desc_parameter('', nodes.Text('/'))
if param.kind == param.KEYWORD_ONLY and last_kind in (param.POSITIONAL_OR_KEYWORD, if param.kind == param.KEYWORD_ONLY and last_kind in (param.POSITIONAL_OR_KEYWORD,
param.POSITIONAL_ONLY, param.POSITIONAL_ONLY,
None): None):
# PEP-3102: Separator for Keyword Only Parameter: * # PEP-3102: Separator for Keyword Only Parameter: *
params += nodes.Text('*') params += addnodes.desc_parameter('', nodes.Text('*'))
node = addnodes.desc_parameter() node = addnodes.desc_parameter()
if param.kind == param.VAR_POSITIONAL: if param.kind == param.VAR_POSITIONAL:
@ -100,7 +100,7 @@ def _parse_arglist(arglist: str) -> addnodes.desc_parameterlist:
if last_kind == Parameter.POSITIONAL_ONLY: if last_kind == Parameter.POSITIONAL_ONLY:
# PEP-570: Separator for Positional Only Parameter: / # PEP-570: Separator for Positional Only Parameter: /
params += nodes.Text('/') params += addnodes.desc_parameter('', nodes.Text('/'))
return params return params

12
tests/test_domain_py.py
View File

@ -278,7 +278,7 @@ def test_pyfunction_signature_full_py38(app):
text = ".. py:function:: hello(*, a)" text = ".. py:function:: hello(*, a)"
doctree = restructuredtext.parse(app, text) doctree = restructuredtext.parse(app, text)
assert_node(doctree[1][0][1], assert_node(doctree[1][0][1],
[desc_parameterlist, ("*", [desc_parameterlist, ([desc_parameter, "*"],
[desc_parameter, ("a", [desc_parameter, ("a",
"=None")])]) "=None")])])
@ -287,9 +287,9 @@ def test_pyfunction_signature_full_py38(app):
doctree = restructuredtext.parse(app, text) doctree = restructuredtext.parse(app, text)
assert_node(doctree[1][0][1], assert_node(doctree[1][0][1],
[desc_parameterlist, ([desc_parameter, "a"], [desc_parameterlist, ([desc_parameter, "a"],
"/", [desc_parameter, "/"],
[desc_parameter, "b"], [desc_parameter, "b"],
"*", [desc_parameter, "*"],
[desc_parameter, ("c", [desc_parameter, ("c",
"=None")])]) "=None")])])
@ -298,8 +298,8 @@ def test_pyfunction_signature_full_py38(app):
doctree = restructuredtext.parse(app, text) doctree = restructuredtext.parse(app, text)
assert_node(doctree[1][0][1], assert_node(doctree[1][0][1],
[desc_parameterlist, ([desc_parameter, "a"], [desc_parameterlist, ([desc_parameter, "a"],
"/", [desc_parameter, "/"],
"*", [desc_parameter, "*"],
[desc_parameter, ("b", [desc_parameter, ("b",
"=None")])]) "=None")])])
@ -308,7 +308,7 @@ def test_pyfunction_signature_full_py38(app):
doctree = restructuredtext.parse(app, text) doctree = restructuredtext.parse(app, text)
assert_node(doctree[1][0][1], assert_node(doctree[1][0][1],
[desc_parameterlist, ([desc_parameter, "a"], [desc_parameterlist, ([desc_parameter, "a"],
"/")]) [desc_parameter, "/"])])
def test_optional_pyfunction_signature(app): def test_optional_pyfunction_signature(app):