Georg Brandl  committed a73ed4d

Small API change.

  • Participants
  • Parent commits c22cd22

Comments (0)

Files changed (2)

File sphinx/ext/

             # the default is only the class docstring
-        # make sure we get Unicode docstrings
-        return [force_decode(docstring, encoding) for docstring in docstrings]
+        # make sure we have Unicode docstrings, then sanitize and split into lines
+        return [prepare_docstring(force_decode(docstring, encoding))
+                for docstring in docstrings]
     def process_doc(self, docstrings, what, name, obj):
         """Let the user process the docstrings."""
         # add content from docstrings
         if not no_docstring:
             encoding = analyzer and analyzer.encoding
-            docstrings = map(prepare_docstring,
-                             self.get_doc(what, todoc, encoding))
+            docstrings = self.get_doc(what, todoc, encoding)
             for i, line in enumerate(self.process_doc(docstrings, what,
                                                       fullname, todoc)):
                 self.result.append(indent + line, sourcename, i)

File tests/

 from docutils.statemachine import ViewList
 from sphinx.ext.autodoc import RstGenerator, cut_lines, between
-from sphinx.util.docstrings import prepare_docstring
 def setup_module():
 def test_get_doc():
     def getdocl(*args):
-        ds = map(prepare_docstring, gen.get_doc(*args))
+        ds = gen.get_doc(*args)
         # for testing purposes, concat them and strip the empty line at the end
         return sum(ds, [])[:-1]
 def test_docstring_processing():
     def process(what, name, obj):
-        return list(gen.process_doc(map(prepare_docstring, gen.get_doc(what, obj)),
-                                    what, name, obj))
+        return list(gen.process_doc(gen.get_doc(what, obj), what, name, obj))
     class E:
         def __init__(self):