diff options
Diffstat (limited to 'sphinx/util/docstrings.py')
-rw-r--r-- | sphinx/util/docstrings.py | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index 2ee2f7282..97dd60294 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """ sphinx.util.docstrings ~~~~~~~~~~~~~~~~~~~~~~ @@ -17,7 +16,7 @@ if False: def prepare_docstring(s, ignore=1): - # type: (unicode, int) -> List[unicode] + # type: (str, int) -> List[str] """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. @@ -51,7 +50,7 @@ def prepare_docstring(s, ignore=1): def prepare_commentdoc(s): - # type: (unicode) -> List[unicode] + # type: (str) -> List[str] """Extract documentation comment lines (starting with #:) and return them as a list of lines. Returns an empty list if there is no documentation. """ |