summaryrefslogtreecommitdiff
path: root/tests/functional
diff options
context:
space:
mode:
Diffstat (limited to 'tests/functional')
-rw-r--r--tests/functional/ext/docparams.py4
-rw-r--r--tests/functional/ext/docparams.txt6
-rw-r--r--tests/functional/m/missing/missing_param_doc.py106
-rw-r--r--tests/functional/m/missing/missing_param_doc.rc8
-rw-r--r--tests/functional/m/missing/missing_param_doc.txt18
-rw-r--r--tests/functional/u/useless/useless_type_doc.py1
-rw-r--r--tests/functional/u/useless/useless_type_doc.txt8
7 files changed, 141 insertions, 10 deletions
diff --git a/tests/functional/ext/docparams.py b/tests/functional/ext/docparams.py
index 269686a01..8dbb0295a 100644
--- a/tests/functional/ext/docparams.py
+++ b/tests/functional/ext/docparams.py
@@ -16,7 +16,7 @@ def _private_func3(param1): # [missing-raises-doc]
raise Exception('Example')
-def public_func1(param1): # [missing-param-doc, missing-type-doc]
+def public_func1(param1): # [missing-any-param-doc]
"""This is a test docstring without params"""
print(param1)
@@ -36,6 +36,6 @@ async def _async_private_func3(param1): # [missing-raises-doc]
raise Exception('Example')
-async def async_public_func1(param1): # [missing-param-doc, missing-type-doc]
+async def async_public_func1(param1): # [missing-any-param-doc]
"""This is a test docstring without params"""
print(param1)
diff --git a/tests/functional/ext/docparams.txt b/tests/functional/ext/docparams.txt
index cccc78126..7aa6631ed 100644
--- a/tests/functional/ext/docparams.txt
+++ b/tests/functional/ext/docparams.txt
@@ -3,12 +3,10 @@ missing-return-type-doc:4:0:_private_func1:Missing return type documentation
missing-yield-doc:9:0:_private_func2:Missing yield documentation
missing-yield-type-doc:9:0:_private_func2:Missing yield type documentation
missing-raises-doc:14:0:_private_func3:"""Exception""" not documented as being raised
-missing-param-doc:19:0:public_func1:"""param1""" missing in parameter documentation
-missing-type-doc:19:0:public_func1:"""param1""" missing in parameter type documentation
+missing-any-param-doc:19:0:public_func1:"Missing any documentation in ""public_func1"""
missing-return-doc:24:0:_async_private_func1:Missing return documentation
missing-return-type-doc:24:0:_async_private_func1:Missing return type documentation
missing-yield-doc:29:0:_async_private_func2:Missing yield documentation
missing-yield-type-doc:29:0:_async_private_func2:Missing yield type documentation
missing-raises-doc:34:0:_async_private_func3:"""Exception""" not documented as being raised
-missing-param-doc:39:0:async_public_func1:"""param1""" missing in parameter documentation
-missing-type-doc:39:0:async_public_func1:"""param1""" missing in parameter type documentation
+missing-any-param-doc:39:0:async_public_func1:"Missing any documentation in ""async_public_func1"""
diff --git a/tests/functional/m/missing/missing_param_doc.py b/tests/functional/m/missing/missing_param_doc.py
new file mode 100644
index 000000000..37c85b058
--- /dev/null
+++ b/tests/functional/m/missing/missing_param_doc.py
@@ -0,0 +1,106 @@
+#pylint: disable= missing-module-docstring
+
+def foobar1(arg1, arg2): #[missing-any-param-doc]
+ """function foobar ...
+ """
+ print(arg1, arg2)
+
+def foobar2(arg1, arg2): #[missing-any-param-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ """
+ print(arg1, arg2)
+
+def foobar3(arg1, arg2, arg3): #[missing-param-doc, missing-type-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ arg1: int
+ arg3: float
+ """
+ print(arg1, arg2, arg3)
+
+def foobar4(arg1, arg2): #[missing-param-doc, missing-type-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ arg1: int
+ description
+ """
+ print(arg1, arg2)
+
+def foobar5(arg1, arg2): #[missing-param-doc, missing-type-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ arg1:
+ description
+ arg2: str
+ """
+ print(arg1, arg2)
+
+def foobar6(arg1, arg2, arg3): #[missing-param-doc, missing-type-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ arg1: int
+ description
+ arg2: int
+ """
+ print(arg1, arg2, arg3)
+
+def foobar7(arg1, arg2): #[missing-any-param-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ arg1
+ """
+ print(arg1, arg2)
+
+def foobar8(arg1): #[missing-any-param-doc]
+ """function foobar"""
+
+ print(arg1)
+
+def foobar9(arg1, arg2, arg3): #[missing-param-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ arg1: int
+ arg2: int
+ arg3: str
+ """
+ print(arg1, arg2, arg3)
+
+def foobar10(arg1, arg2, arg3): #[missing-param-doc, missing-type-doc]
+ """function foobar ...
+ Parameters
+ ----------
+ arg1:
+ desc1
+ arg2: int
+ arg3:
+ desc3
+ """
+ print(arg1, arg2, arg3)
+
+def foobar11(arg1, arg2): #[missing-any-param-doc]
+ """function foobar ...
+ Args
+ ----------
+ arg1
+ arg2
+ """
+ print(arg1, arg2)
+
+def foobar12(arg1, arg2, arg3): #[missing-param-doc, missing-type-doc]
+ """function foobar ...
+ Args
+ ----------
+ arg1: int
+ arg2:
+ does something
+ arg3
+ """
+ print(arg1, arg2, arg3)
diff --git a/tests/functional/m/missing/missing_param_doc.rc b/tests/functional/m/missing/missing_param_doc.rc
new file mode 100644
index 000000000..d4a6dc172
--- /dev/null
+++ b/tests/functional/m/missing/missing_param_doc.rc
@@ -0,0 +1,8 @@
+[MASTER]
+load-plugins=pylint.extensions.docparams,
+
+[PARAMETER_DOCUMENTATION]
+accept-no-param-doc=no
+accept-no-raise-doc=no
+accept-no-return-doc=no
+accept-no-yields-doc=no
diff --git a/tests/functional/m/missing/missing_param_doc.txt b/tests/functional/m/missing/missing_param_doc.txt
new file mode 100644
index 000000000..b03e20072
--- /dev/null
+++ b/tests/functional/m/missing/missing_param_doc.txt
@@ -0,0 +1,18 @@
+missing-any-param-doc:3:0:foobar1:"Missing any documentation in ""foobar1"""
+missing-any-param-doc:8:0:foobar2:"Missing any documentation in ""foobar2"""
+missing-param-doc:15:0:foobar3:"""arg1, arg2, arg3"" missing in parameter documentation"
+missing-type-doc:15:0:foobar3:"""arg2"" missing in parameter type documentation"
+missing-param-doc:24:0:foobar4:"""arg2"" missing in parameter documentation"
+missing-type-doc:24:0:foobar4:"""arg2"" missing in parameter type documentation"
+missing-param-doc:33:0:foobar5:"""arg2"" missing in parameter documentation"
+missing-type-doc:33:0:foobar5:"""arg1"" missing in parameter type documentation"
+missing-param-doc:43:0:foobar6:"""arg2, arg3"" missing in parameter documentation"
+missing-type-doc:43:0:foobar6:"""arg3"" missing in parameter type documentation"
+missing-any-param-doc:53:0:foobar7:"Missing any documentation in ""foobar7"""
+missing-any-param-doc:61:0:foobar8:"Missing any documentation in ""foobar8"""
+missing-param-doc:66:0:foobar9:"""arg1, arg2, arg3"" missing in parameter documentation"
+missing-param-doc:76:0:foobar10:"""arg2"" missing in parameter documentation"
+missing-type-doc:76:0:foobar10:"""arg1, arg3"" missing in parameter type documentation"
+missing-any-param-doc:88:0:foobar11:Missing any documentation in "foobar11"
+missing-param-doc:97:0:foobar12:"""arg1, arg3"" missing in parameter documentation"
+missing-type-doc:97:0:foobar12:"""arg2, arg3"" missing in parameter type documentation"
diff --git a/tests/functional/u/useless/useless_type_doc.py b/tests/functional/u/useless/useless_type_doc.py
index 6714755fd..110a7a5f5 100644
--- a/tests/functional/u/useless/useless_type_doc.py
+++ b/tests/functional/u/useless/useless_type_doc.py
@@ -1,3 +1,4 @@
+#pylint: disable = missing-any-param-doc
"""demonstrate FP with useless-type-doc"""
diff --git a/tests/functional/u/useless/useless_type_doc.txt b/tests/functional/u/useless/useless_type_doc.txt
index 20083ed79..9e1963e90 100644
--- a/tests/functional/u/useless/useless_type_doc.txt
+++ b/tests/functional/u/useless/useless_type_doc.txt
@@ -1,4 +1,4 @@
-useless-param-doc:33:0:function_useless_doc:"""_some_private_param"" useless ignored parameter documentation":HIGH
-useless-type-doc:33:0:function_useless_doc:"""_some_private_param"" useless ignored parameter type documentation":HIGH
-useless-param-doc:66:0:test_two:"""_new"" useless ignored parameter documentation":HIGH
-useless-type-doc:66:0:test_two:"""_new"" useless ignored parameter type documentation":HIGH
+useless-param-doc:34:0:function_useless_doc:"""_some_private_param"" useless ignored parameter documentation":HIGH
+useless-type-doc:34:0:function_useless_doc:"""_some_private_param"" useless ignored parameter type documentation":HIGH
+useless-param-doc:67:0:test_two:"""_new"" useless ignored parameter documentation":HIGH
+useless-type-doc:67:0:test_two:"""_new"" useless ignored parameter type documentation":HIGH