Merge pull request #1 from tacaswell/yield_section

ENH : simplify handling of Yield section

Author: chebee7i

numpydoc/docscrape.py

@@ -393,8 +393,8 @@ def __str__(self, func_role=''):
         out += self._str_signature()
         out += self._str_summary()
         out += self._str_extended_summary()
-        for param_list in ('Parameters', 'Returns', 'Other Parameters',
-                           'Raises', 'Warns'):
+        for param_list in ('Parameters', 'Returns', 'Yields',
+                           'Other Parameters', 'Raises', 'Warns'):
             out += self._str_param_list(param_list)
         out += self._str_section('Warnings')
         out += self._str_see_also(func_role)

numpydoc/docscrape_sphinx.py

@@ -63,23 +63,6 @@ def _str_returns(self):
                 out += ['']
         return out
 
-    def _str_yields(self):
-        out = []
-        if self['Yields']:
-            out += self._str_field_list('Yields')
-            out += ['']
-            for param, param_type, desc in self['Yields']:
-                if param_type:
-                    out += self._str_indent(['**%s** : %s' % (param.strip(),
-                                                              param_type)])
-                else:
-                    out += self._str_indent([param.strip()])
-                if desc:
-                    out += ['']
-                    out += self._str_indent(desc, 8)
-                out += ['']
-        return out
-
     def _str_param_list(self, name):
         out = []
         if self[name]:
@@ -242,6 +225,7 @@ def __str__(self, indent=0, func_role="obj"):
         out += self._str_extended_summary()
         out += self._str_param_list('Parameters')
         out += self._str_returns()
+        out += self._str_param_list('Yields')
         for param_list in ('Other Parameters', 'Raises', 'Warns'):
             out += self._str_param_list(param_list)
         out += self._str_warnings()

numpydoc/tests/test_docscrape.py

@@ -178,7 +178,6 @@ def test_yields():
 """
     doc = NumpyDocString(doc_text)
     section = doc['Yields']
-    print(section)
     assert_equal(len(section), 2)
     truth = [('a', 'apples.'), ('b', 'bananas.')]
     for (arg, arg_type, desc), (arg_true, ending) in zip(section, truth):