TST: More unit tests for the Yields section.

Author: chebee7i

numpydoc/docscrape_sphinx.py

@@ -46,12 +46,12 @@ def _str_summary(self):
     def _str_extended_summary(self):
         return self['Extended Summary'] + ['']
 
-    def _str_returns(self):
+    def _str_returns(self, name='Returns'):
         out = []
-        if self['Returns']:
-            out += self._str_field_list('Returns')
+        if self[name]:
+            out += self._str_field_list(name)
             out += ['']
-            for param, param_type, desc in self['Returns']:
+            for param, param_type, desc in self[name]:
                 if param_type:
                     out += self._str_indent(['**%s** : %s' % (param.strip(),
                                                               param_type)])
@@ -225,7 +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')
+        out += self._str_returns('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

@@ -122,6 +122,20 @@
   '''
 doc = NumpyDocString(doc_txt)
 
+doc_yields_txt = """
+Test generator
+
+Yields
+------
+a : int
+    The number of apples.
+b : int
+    The number of bananas.
+int
+    The number of unknowns.
+"""
+doc_yields = NumpyDocString(doc_yields_txt)
+
 
 def test_signature():
     assert doc['Signature'].startswith('numpy.multivariate_normal(')
@@ -165,8 +179,25 @@ def test_returns():
     assert desc[-1].endswith('anonymous return values.')
 
 def test_yields():
+    section = doc_yields['Yields']
+    assert_equal(len(section), 3)
+    truth = [('a', 'int', 'apples.'),
+             ('b', 'int', 'bananas.'),
+             ('int', '', 'unknowns.')]
+    for (arg, arg_type, desc), (arg_, arg_type_, end) in zip(section, truth):
+        assert_equal(arg, arg_)
+        assert_equal(arg_type, arg_type_)
+        assert desc[0].startswith('The number of')
+        assert desc[0].endswith(end)
+
+def test_returnyield():
     doc_text = """
-Test generator
+Test having returns and yields.
+
+Returns
+-------
+int
+    The number of apples.
 
 Yields
 ------
@@ -176,15 +207,7 @@ def test_yields():
     The number of bananas.
 
 """
-    doc = NumpyDocString(doc_text)
-    section = doc['Yields']
-    assert_equal(len(section), 2)
-    truth = [('a', 'apples.'), ('b', 'bananas.')]
-    for (arg, arg_type, desc), (arg_true, ending) in zip(section, truth):
-        assert_equal(arg, arg_true)
-        assert_equal(arg_type, 'int')
-        assert desc[0].startswith('The number of')
-        assert desc[0].endswith(ending)
+    assert_raises(ValueError, NumpyDocString, doc_text)
 
 def test_notes():
     assert doc['Notes'][0].startswith('Instead')
@@ -215,6 +238,9 @@ def non_blank_line_by_line_compare(a,b):
                                  "\n>>> %s\n<<< %s\n" %
                                  (n,line,b[n]))
 def test_str():
+    # doc_txt has the order of Notes and See Also sections flipped.
+    # This should be handled automatically, and so, one thing this test does
+    # is to make sure that See Also precedes Notes in the output.
     non_blank_line_by_line_compare(str(doc),
 """numpy.multivariate_normal(mean, cov, shape=None, spam=None)
 
@@ -324,6 +350,22 @@ def test_str():
    :refguide: random;distributions, random;gauss""")
 
 
+def test_yield_str():
+    non_blank_line_by_line_compare(str(doc_yields),
+"""Test generator
+
+Yields
+------
+a : int
+    The number of apples.
+b : int
+    The number of bananas.
+int
+    The number of unknowns.
+
+.. index:: """)
+
+
 def test_sphinx_str():
     sphinx_doc = SphinxDocString(doc_txt)
     non_blank_line_by_line_compare(str(sphinx_doc),
@@ -449,6 +491,27 @@ def test_sphinx_str():
 """)
 
 
+def test_sphinx_yields_str():
+    sphinx_doc = SphinxDocString(doc_yields_txt)
+    non_blank_line_by_line_compare(str(sphinx_doc),
+"""Test generator
+
+:Yields:
+
+    **a** : int
+
+        The number of apples.
+
+    **b** : int
+
+        The number of bananas.
+
+    int
+
+        The number of unknowns.
+""")
+
+
 doc2 = NumpyDocString("""
     Returns array of indices of the maximum values of along the given axis.