summaryrefslogtreecommitdiff
path: root/tests/functional/ext/docparams/parameter/missing_param_doc_required.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/functional/ext/docparams/parameter/missing_param_doc_required.py')
-rw-r--r--tests/functional/ext/docparams/parameter/missing_param_doc_required.py51
1 files changed, 51 insertions, 0 deletions
diff --git a/tests/functional/ext/docparams/parameter/missing_param_doc_required.py b/tests/functional/ext/docparams/parameter/missing_param_doc_required.py
new file mode 100644
index 000000000..072645505
--- /dev/null
+++ b/tests/functional/ext/docparams/parameter/missing_param_doc_required.py
@@ -0,0 +1,51 @@
+"""Tests for missing-param-doc and missing-type-doc for non-specified style docstrings
+with accept-no-param-doc = no
+"""
+# pylint: disable=invalid-name, unused-argument, too-few-public-methods
+
+
+def test_don_t_tolerate_no_param_documentation_at_all(x, y): # [missing-any-param-doc]
+ """Example of a function with no parameter documentation at all
+
+ Missing documentation error message is emitted.
+
+ missing parameter documentation"""
+
+
+def test_see_tolerate_no_param_documentation_at_all(x, y):
+ """Example for the usage of "For the parameters, see"
+ to suppress missing-param warnings.
+
+ For the parameters, see :func:`blah`
+ """
+
+
+class ClassFoo:
+ """Example usage of "For the parameters, see" in init docstring"""
+
+ def __init__(self, x, y):
+ """docstring foo constructor
+
+ For the parameters, see :func:`bla`
+ """
+
+
+class ClassFooTwo:
+ """test_see_sentence_for_constr_params_in_class
+ Example usage of "For the parameters, see" in class docstring
+
+ For the parameters, see :func:`bla`
+ """
+
+ def __init__(self, x, y):
+ """init"""
+
+
+def test_kwonlyargs_are_taken_in_account( # [missing-param-doc, missing-type-doc]
+ arg, *, kwonly, missing_kwonly
+):
+ """The docstring
+
+ :param int arg: The argument.
+ :param bool kwonly: A keyword-arg.
+ """