@@ -39,35 +39,35 @@ def test_validate_hook(example_module, config, capsys):
39
39
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
40
40
| numpydoc/tests/hooks/example_module.py:4 | example_module.some_function | EX01 | No examples section found |
41
41
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
42
- | numpydoc/tests/hooks/example_module.py:9 | example_module.MyClass | ES01 | No extended summary found |
42
+ | numpydoc/tests/hooks/example_module.py:8 | example_module.MyClass | ES01 | No extended summary found |
43
43
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
44
- | numpydoc/tests/hooks/example_module.py:9 | example_module.MyClass | SA01 | See Also section not found |
44
+ | numpydoc/tests/hooks/example_module.py:8 | example_module.MyClass | SA01 | See Also section not found |
45
45
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
46
- | numpydoc/tests/hooks/example_module.py:9 | example_module.MyClass | EX01 | No examples section found |
46
+ | numpydoc/tests/hooks/example_module.py:8 | example_module.MyClass | EX01 | No examples section found |
47
47
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
48
- | numpydoc/tests/hooks/example_module.py:12 | example_module.MyClass.__init__ | GL08 | The object does not have a docstring |
48
+ | numpydoc/tests/hooks/example_module.py:11 | example_module.MyClass.__init__ | GL08 | The object does not have a docstring |
49
49
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
50
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | ES01 | No extended summary found |
50
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | ES01 | No extended summary found |
51
51
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
52
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
52
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
53
53
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
54
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
54
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
55
55
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
56
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | SA01 | See Also section not found |
56
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | SA01 | See Also section not found |
57
57
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
58
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | EX01 | No examples section found |
58
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | EX01 | No examples section found |
59
59
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
60
- | numpydoc/tests/hooks/example_module.py:28 | example_module.MyClass.process | SS05 | Summary must start with infinitive verb, not third |
60
+ | numpydoc/tests/hooks/example_module.py:26 | example_module.MyClass.process | SS05 | Summary must start with infinitive verb, not third |
61
61
| | | | person (e.g. use "Generate" instead of |
62
62
| | | | "Generates") |
63
63
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
64
- | numpydoc/tests/hooks/example_module.py:28 | example_module.MyClass.process | ES01 | No extended summary found |
64
+ | numpydoc/tests/hooks/example_module.py:26 | example_module.MyClass.process | ES01 | No extended summary found |
65
65
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
66
- | numpydoc/tests/hooks/example_module.py:28 | example_module.MyClass.process | SA01 | See Also section not found |
66
+ | numpydoc/tests/hooks/example_module.py:26 | example_module.MyClass.process | SA01 | See Also section not found |
67
67
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
68
- | numpydoc/tests/hooks/example_module.py:28 | example_module.MyClass.process | EX01 | No examples section found |
68
+ | numpydoc/tests/hooks/example_module.py:26 | example_module.MyClass.process | EX01 | No examples section found |
69
69
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
70
- | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass | GL08 | The object does not have a docstring |
70
+ | numpydoc/tests/hooks/example_module.py:30 | example_module.NewClass | GL08 | The object does not have a docstring |
71
71
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
72
72
"""
73
73
)
@@ -90,17 +90,17 @@ def test_validate_hook_with_ignore(example_module, capsys):
90
90
+===========================================+=====================================+=========+====================================================+
91
91
| numpydoc/tests/hooks/example_module.py:4 | example_module.some_function | PR01 | Parameters {'name'} not documented |
92
92
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
93
- | numpydoc/tests/hooks/example_module.py:12 | example_module.MyClass.__init__ | GL08 | The object does not have a docstring |
93
+ | numpydoc/tests/hooks/example_module.py:11 | example_module.MyClass.__init__ | GL08 | The object does not have a docstring |
94
94
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
95
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
95
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
96
96
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
97
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
97
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
98
98
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
99
- | numpydoc/tests/hooks/example_module.py:28 | example_module.MyClass.process | SS05 | Summary must start with infinitive verb, not third |
99
+ | numpydoc/tests/hooks/example_module.py:26 | example_module.MyClass.process | SS05 | Summary must start with infinitive verb, not third |
100
100
| | | | person (e.g. use "Generate" instead of |
101
101
| | | | "Generates") |
102
102
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
103
- | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass | GL08 | The object does not have a docstring |
103
+ | numpydoc/tests/hooks/example_module.py:30 | example_module.NewClass | GL08 | The object does not have a docstring |
104
104
+-------------------------------------------+-------------------------------------+---------+----------------------------------------------------+
105
105
"""
106
106
)
@@ -145,11 +145,11 @@ def test_validate_hook_with_toml_config(example_module, tmp_path, capsys):
145
145
+===========================================+=====================================+=========+========================================+
146
146
| numpydoc/tests/hooks/example_module.py:4 | example_module.some_function | PR01 | Parameters {'name'} not documented |
147
147
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
148
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
148
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
149
149
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
150
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
150
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
151
151
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
152
- | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass | GL08 | The object does not have a docstring |
152
+ | numpydoc/tests/hooks/example_module.py:30 | example_module.NewClass | GL08 | The object does not have a docstring |
153
153
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
154
154
"""
155
155
)
@@ -184,11 +184,11 @@ def test_validate_hook_with_setup_cfg(example_module, tmp_path, capsys):
184
184
+===========================================+=====================================+=========+========================================+
185
185
| numpydoc/tests/hooks/example_module.py:4 | example_module.some_function | PR01 | Parameters {'name'} not documented |
186
186
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
187
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
187
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
188
188
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
189
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
189
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
190
190
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
191
- | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass | GL08 | The object does not have a docstring |
191
+ | numpydoc/tests/hooks/example_module.py:30 | example_module.NewClass | GL08 | The object does not have a docstring |
192
192
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
193
193
"""
194
194
)
@@ -235,7 +235,7 @@ def test_validate_hook_exclude_option_pyproject(example_module, tmp_path, capsys
235
235
+===========================================+==============================+=========+======================================+
236
236
| numpydoc/tests/hooks/example_module.py:4 | example_module.some_function | PR01 | Parameters {'name'} not documented |
237
237
+-------------------------------------------+------------------------------+---------+--------------------------------------+
238
- | numpydoc/tests/hooks/example_module.py:33 | example_module.NewClass | GL08 | The object does not have a docstring |
238
+ | numpydoc/tests/hooks/example_module.py:30 | example_module.NewClass | GL08 | The object does not have a docstring |
239
239
+-------------------------------------------+------------------------------+---------+--------------------------------------+
240
240
"""
241
241
)
@@ -270,9 +270,9 @@ def test_validate_hook_exclude_option_setup_cfg(example_module, tmp_path, capsys
270
270
+===========================================+=====================================+=========+========================================+
271
271
| numpydoc/tests/hooks/example_module.py:4 | example_module.some_function | PR01 | Parameters {'name'} not documented |
272
272
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
273
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
273
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR01 | Parameters {'**kwargs'} not documented |
274
274
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
275
- | numpydoc/tests/hooks/example_module.py:18 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
275
+ | numpydoc/tests/hooks/example_module.py:17 | example_module.MyClass.do_something | PR07 | Parameter "*args" has no description |
276
276
+-------------------------------------------+-------------------------------------+---------+----------------------------------------+
277
277
"""
278
278
)
0 commit comments