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

add a comment about default not being a official keyword

Browse Source
This commit is contained in:
Keewis 2020-07-25 11:54:02 +02:00
parent 6ae1c601b9
commit 864dd0b610
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/ext/napoleon/docstring.py
View File

@ -899,6 +899,8 @@ def _token_type(token: str, location: str = None) -> str:
) )
type_ = "literal" type_ = "literal"
elif token in ("optional", "default"): elif token in ("optional", "default"):
# default is not a official keyword (yet) but supported by the
# reference implementation (numpydoc) and widely used
type_ = "control" type_ = "control"
elif _xref_regex.match(token): elif _xref_regex.match(token):
type_ = "reference" type_ = "reference"