blob: ba530484b4905eb84bf856e8d2556c80767b264f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
"""Tests for missing-return-doc and missing-return-type-doc for Google style docstrings"""
# pylint: disable=function-redefined, invalid-name, undefined-variable, missing-function-docstring
# pylint: disable=unused-argument
def my_func(self):
"""find_google_returns
Returns:
bool: Always False
"""
return False
def my_func(self, doc_type):
"""ignores_google_return_none
Args:
doc_type (str): Google
"""
return
def my_func(self):
"""finds_google_return_custom_class
Returns:
mymodule.Class: An object
"""
return mymodule.Class()
def my_func(self):
"""finds_google_return_list_of_custom_class
Returns:
list(:class:`mymodule.Class`): An object
"""
return [mymodule.Class()]
def my_func(self): # [redundant-returns-doc]
"""warns_google_redundant_return_doc
Returns:
One
"""
return None
def my_func(self): # [redundant-returns-doc]
"""warns_google_redundant_rtype_doc
Returns:
int:
"""
return None
def my_func(self): # [redundant-returns-doc]
"""warns_google_redundant_return_doc_yield
Returns:
int: One
"""
yield 1
def my_func(self):
"""ignores_google_redundant_return_doc_multiple_returns
Returns:
int or None: One, or sometimes None.
"""
if a_func():
return None
return 1
|
