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

[Napoleon] Removes Python 2/3 compatible type annotation doc example, because they aren't current supported by Sphinx

Browse Source
This commit is contained in:
Rob Ruana 2016-07-02 11:43:55 -04:00
parent e3c3e4f0cb
commit 8eecdbd715
1 changed files with 4 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/ext/napoleon.rst
View File

@ -213,24 +213,6 @@ Google style with Python 3 type annotations::
""" """
return True return True
Google style with `Python 2/3 compatible annotations`_::
def func(arg1, arg2):
# type: (int, str) -> bool
"""Summary line.
Extended description of function.
Args:
arg1: Description of arg1
arg2: Description of arg2
Returns:
Description of return value
"""
return True
Google style with types in docstrings:: Google style with types in docstrings::
def func(arg1, arg2): def func(arg1, arg2):
@ -248,6 +230,10 @@ Google style with types in docstrings::
""" """
return True return True
.. Note::
`Python 2/3 compatible annotations`_ aren't currently
supported by Sphinx and won't show up in the docs.
.. _PEP 484: .. _PEP 484:
https://www.python.org/dev/peps/pep-0484/ https://www.python.org/dev/peps/pep-0484/