blob: 55bf569198727975cbcb3a4485a3a660ab2b2240 (
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
78
79
|
"""Tests for missing-return-doc and missing-return-type-doc for Sphinx style docstrings"""
# pylint: disable=function-redefined, invalid-name, undefined-variable, missing-function-docstring
# pylint: disable=unused-argument
def my_func(self):
"""find_sphinx_returns
:return: Always False
:rtype: bool
"""
return False
def my_func(self, doc_type):
"""ignores_sphinx_return_none
:param doc_type: Sphinx
:type doc_type: str
"""
return
def my_func(self):
"""finds_sphinx_return_custom_class
:returns: An object
:rtype: :class:`mymodule.Class`
"""
return mymodule.Class()
def my_func(self):
"""finds_sphinx_return_list_of_custom_class
:returns: An object
:rtype: list(:class:`mymodule.Class`)
"""
return [mymodule.Class()]
def my_func(self): # [redundant-returns-doc]
"""warns_sphinx_redundant_return_doc
:returns: One
"""
return None
def my_func(self): # [redundant-returns-doc]
"""warns_sphinx_redundant_rtype_doc
:rtype: int
"""
return None
def my_func(self):
"""ignores_sphinx_redundant_return_doc_multiple_returns
:returns: One
:rtype: int
:returns: None sometimes
:rtype: None
"""
if a_func():
return None
return 1
def my_func_with_yield(self):
"""ignore_sphinx_redundant_return_doc_yield
:returns: One
:rtype: generator
"""
for value in range(3):
yield value
|
