summaryrefslogtreecommitdiff
path: root/tests/extensions/test_check_docs.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/extensions/test_check_docs.py')
-rw-r--r--tests/extensions/test_check_docs.py18
1 files changed, 18 insertions, 0 deletions
diff --git a/tests/extensions/test_check_docs.py b/tests/extensions/test_check_docs.py
index 234ff6da4..90ccf6334 100644
--- a/tests/extensions/test_check_docs.py
+++ b/tests/extensions/test_check_docs.py
@@ -75,6 +75,24 @@ class TestParamDocChecker(CheckerTestCase):
):
self.checker.visit_functiondef(node)
+ def test_missing_type_doc_google_docstring_exempt_kwonly_args(self):
+ node = astroid.extract_node(
+ """
+ def identifier_kwarg_method(arg1: int, arg2: int, *, value1: str, value2: str):
+ '''Code to show failure in missing-type-doc
+
+ Args:
+ arg1: First argument.
+ arg2: Second argument.
+ value1: First kwarg.
+ value2: Second kwarg.
+ '''
+ print("NOTE: It doesn't like anything after the '*'.")
+ """
+ )
+ with self.assertNoMessages():
+ self.checker.visit_functiondef(node)
+
def test_missing_func_params_with_annotations_in_google_docstring(self):
"""Example of a function with missing Google style parameter
documentation in the docstring.