diff options
Diffstat (limited to 'pylint/test/extensions/test_check_yields_docs.py')
-rw-r--r-- | pylint/test/extensions/test_check_yields_docs.py | 69 |
1 files changed, 32 insertions, 37 deletions
diff --git a/pylint/test/extensions/test_check_yields_docs.py b/pylint/test/extensions/test_check_yields_docs.py index 98fb82780..42455aa4b 100644 --- a/pylint/test/extensions/test_check_yields_docs.py +++ b/pylint/test/extensions/test_check_yields_docs.py @@ -36,9 +36,8 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node), + Message(msg_id='missing-yield-type-doc', node=node)): self.checker.visit_yield(yield_node) def test_ignores_unknown_style(self): @@ -61,9 +60,7 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-type-doc', node=node)): self.checker.visit_yield(yield_node) def test_warn_partial_sphinx_yields_type(self): @@ -77,9 +74,7 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node)): self.checker.visit_yield(yield_node) def test_warn_missing_sphinx_yields(self): @@ -94,9 +89,8 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node), + Message(msg_id='missing-yield-type-doc', node=node)): self.checker.visit_yield(yield_node) def test_warn_partial_google_yields(self): @@ -111,9 +105,22 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-type-doc', node=node)): + self.checker.visit_yield(yield_node) + + def test_warn_partial_google_yields_type(self): + node = astroid.extract_node(''' + def my_func(self): + """This is a docstring. + + Yields: + bool: + """ + yield False + ''') + yield_node = node.body[0] + with self.assertAddsMessages( + Message(msg_id='missing-yield-doc', node=node)): self.checker.visit_yield(yield_node) def test_warn_missing_google_yields(self): @@ -128,9 +135,8 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node), + Message(msg_id='missing-yield-type-doc', node=node)): self.checker.visit_yield(yield_node) def test_warn_missing_numpy_yields(self): @@ -147,9 +153,8 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node), + Message(msg_id='missing-yield-type-doc', node=node)): self.checker.visit_yield(yield_node) def test_find_sphinx_yields(self): @@ -286,9 +291,7 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node)): self.checker.visit_yield(yield_node) def test_warns_google_yield_list_of_custom_class_without_description(self): @@ -297,15 +300,13 @@ class DocstringCheckerYieldTest(CheckerTestCase): """This is a docstring. Yields: - list(:class:`mymodule.Class`) + list(:class:`mymodule.Class`): """ yield [mymodule.Class()] ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node)): self.checker.visit_yield(yield_node) def test_warns_numpy_yield_list_of_custom_class_without_description(self): @@ -321,9 +322,7 @@ class DocstringCheckerYieldTest(CheckerTestCase): ''') yield_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-yields-doc', - node=node)): + Message(msg_id='missing-yield-doc', node=node)): self.checker.visit_yield(yield_node) # No such thing as redundant yield documentation for sphinx because it @@ -377,9 +376,7 @@ class DocstringCheckerYieldTest(CheckerTestCase): return 1 ''') with self.assertAddsMessages( - Message( - msg_id='redundant-yields-doc', - node=node)): + Message(msg_id='redundant-yields-doc', node=node)): self.checker.visit_functiondef(node) def test_warns_numpy_redundant_yield_doc_return(self): @@ -395,9 +392,7 @@ class DocstringCheckerYieldTest(CheckerTestCase): return 1 ''') with self.assertAddsMessages( - Message( - msg_id='redundant-yields-doc', - node=node)): + Message(msg_id='redundant-yields-doc', node=node)): self.checker.visit_functiondef(node) |