Add unit test for Yields section.

Author: chebee7i

numpydoc/docscrape.py

@@ -292,8 +292,9 @@ def _parse(self):
         for (section,content) in self._read_sections():
             if not section.startswith('..'):
                 section = ' '.join([s.capitalize() for s in section.split(' ')])
-            if section in ('Parameters', 'Returns', 'Raises', 'Warns',
-                           'Other Parameters', 'Attributes', 'Methods'):
+            if section in ('Parameters', 'Returns', 'Yields', 'Raises',
+                           'Warns', 'Other Parameters', 'Attributes',
+                           'Methods'):
                 self[section] = self._parse_param_list(content)
             elif section.startswith('.. index::'):
                 self['index'] = self._parse_index(section, content)

numpydoc/tests/test_docscrape.py

@@ -164,6 +164,29 @@ def test_returns():
     assert desc[0].startswith('This is not a real')
     assert desc[-1].endswith('anonymous return values.')
 
+def test_yields():
+    doc_text = """
+Test generator
+
+Yields
+------
+a : int
+    The number of apples.
+b : int
+    The number of bananas.
+
+"""
+    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):
+        assert_equal(arg, arg_true)
+        assert_equal(arg_type, 'int')
+        assert desc[0].startswith('The number of')
+        assert desc[0].endswith(ending)
+
 def test_notes():
     assert doc['Notes'][0].startswith('Instead')
     assert doc['Notes'][-1].endswith('definite.')