diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-12-16 00:32:10 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-12-16 00:32:10 +0900 |
commit | c70e65fc6cd04d02df4f7911025f534dbd27cc20 (patch) | |
tree | 1e8614ac5516dace99ef1df4d203081662c7c2d6 /sphinx/util/docstrings.py | |
parent | d6d4406ce987cc8823d1b3a33be3a418bcd2a59d (diff) | |
parent | 79eec90f36f5a74e24cfd6740126396fd6567e07 (diff) | |
download | sphinx-git-c70e65fc6cd04d02df4f7911025f534dbd27cc20.tar.gz |
Merge branch 'master' into 5770_doctest_refers_highlight_language
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 5cd12a177..8cd4e5fc5 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -14,11 +14,10 @@ import sys if False: # For type annotation from typing import List # NOQA - from sphinx.util.typing import unicode # NOQA 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. @@ -52,7 +51,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. """ |