summaryrefslogtreecommitdiff
path: root/sphinx/util/docstrings.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-08-22 11:36:08 +0200
committerGeorg Brandl <georg@python.org>2010-08-22 11:36:08 +0200
commit5978c17aed477cc2bbab7eae86bb8b18367c426e (patch)
tree8a31a3695744a106791724453db559985f874c8e /sphinx/util/docstrings.py
parentf160503120e0f72ea8b70bb850c92b8023bb9f6e (diff)
downloadsphinx-5978c17aed477cc2bbab7eae86bb8b18367c426e.tar.gz
Docstring harmonization.
Diffstat (limited to 'sphinx/util/docstrings.py')
-rw-r--r--sphinx/util/docstrings.py15
1 files changed, 7 insertions, 8 deletions
diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py
index 538af653..d1a2ff8d 100644
--- a/sphinx/util/docstrings.py
+++ b/sphinx/util/docstrings.py
@@ -13,11 +13,11 @@ import sys
def prepare_docstring(s):
- """
- Convert a docstring into lines of parseable reST. Return it as a list of
- lines usable for inserting into a docutils ViewList (used as argument
- of nested_parse().) An empty line is added to act as a separator between
- this docstring and following content.
+ """Convert a docstring into lines of parseable reST.
+
+ Return it as a list of lines usable for inserting into a docutils ViewList
+ (used as argument of nested_parse().) An empty line is added to act as a
+ separator between this docstring and following content.
"""
lines = s.expandtabs().splitlines()
# Find minimum indentation of any non-blank lines after first line.
@@ -42,9 +42,8 @@ def prepare_docstring(s):
def prepare_commentdoc(s):
- """
- Extract documentation comment lines (starting with #:) and return them as a
- list of lines. Returns an empty list if there is no documentation.
+ """Extract documentation comment lines (starting with #:) and return them
+ as a list of lines. Returns an empty list if there is no documentation.
"""
result = []
lines = [line.strip() for line in s.expandtabs().splitlines()]