diff options
Diffstat (limited to 'tests/functional/u')
| -rw-r--r-- | tests/functional/u/useless/useless_type_doc.py | 27 | ||||
| -rw-r--r-- | tests/functional/u/useless/useless_type_doc.txt | 4 |
2 files changed, 28 insertions, 3 deletions
diff --git a/tests/functional/u/useless/useless_type_doc.py b/tests/functional/u/useless/useless_type_doc.py index 88dedb479..6714755fd 100644 --- a/tests/functional/u/useless/useless_type_doc.py +++ b/tests/functional/u/useless/useless_type_doc.py @@ -1,5 +1,4 @@ """demonstrate FP with useless-type-doc""" -# line-too-long def function(public_param: int, _some_private_param: bool = False) -> None: @@ -16,6 +15,20 @@ def function(public_param: int, _some_private_param: bool = False) -> None: ... +def smart_function(public_param: int, _some_private_param: bool = False) -> None: + """We're speaking about _some_private_param without really documenting it. + + Args: + public_param: an ordinary parameter + """ + for _ in range(public_param): + ... + if _some_private_param: + ... + else: + ... + + # +1: [useless-type-doc,useless-param-doc] def function_useless_doc(public_param: int, _some_private_param: bool = False) -> None: """does things @@ -33,7 +46,7 @@ def function_useless_doc(public_param: int, _some_private_param: bool = False) - ... -def test(_new: str) -> str: # We don't expect useless-type-doc here +def test(_new: str) -> str: """foobar :return: comment @@ -41,8 +54,16 @@ def test(_new: str) -> str: # We don't expect useless-type-doc here return "" +def smarter_test(_new: str) -> str: + """We're speaking about _new without really documenting it. + + :return: comment + """ + return "" + + # +1: [useless-type-doc,useless-param-doc] -def test_two(_new: str) -> str: # We don't expect useless-type-doc here +def test_two(_new: str) -> str: """foobar :param str _new: diff --git a/tests/functional/u/useless/useless_type_doc.txt b/tests/functional/u/useless/useless_type_doc.txt new file mode 100644 index 000000000..20083ed79 --- /dev/null +++ b/tests/functional/u/useless/useless_type_doc.txt @@ -0,0 +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 |