summaryrefslogtreecommitdiff
path: root/sphinx/util/docstrings.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2017-02-08 14:31:59 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2017-02-08 18:38:42 +0900
commit6fa0262802a09050e09445c9fd630c69b5ad1204 (patch)
treea2ad8f7849540d1b027e0b99d9913394b23c58d8 /sphinx/util/docstrings.py
parent81eb101e9f8fcee1c439ee0dd501d135eced01c6 (diff)
downloadsphinx-git-6fa0262802a09050e09445c9fd630c69b5ad1204.tar.gz
Fix mypy violations
Diffstat (limited to 'sphinx/util/docstrings.py')
-rw-r--r--sphinx/util/docstrings.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py
index fba9bf490..e79408da2 100644
--- a/sphinx/util/docstrings.py
+++ b/sphinx/util/docstrings.py
@@ -13,6 +13,7 @@ import sys
def prepare_docstring(s, ignore=1):
+ # type: (unicode, int) -> List[unicode]
"""Convert a docstring into lines of parseable reST. Remove common leading
indentation, where the indentation of a given number of lines (usually just
one) is ignored.
@@ -46,6 +47,7 @@ def prepare_docstring(s, ignore=1):
def prepare_commentdoc(s):
+ # type: (unicode) -> List[unicode]
"""Extract documentation comment lines (starting with #:) and return them
as a list of lines. Returns an empty list if there is no documentation.
"""