validate docstrings in tracingfuncs.py with numpydoc-validate.

[ns-rse]

Currently topostats/tracing/tracingfuncs.py on maxgamill-sheffield/800-better-tracing (1fa9988) has the following issues...

❱ pre-commit run numpydoc-validation --file topostats/tracing/tracingfuncs.py 
numpydoc-validation......................................................Failed
- hook id: numpydoc-validation
- exit code: 1

+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| file                                  | item                                               | check   | description                                        |
+=======================================+====================================================+=========+====================================================+
| topostats/tracing/tracingfuncs.py:18  | tracingfuncs.reorderTrace.linearTrace              | GL01    | Docstring text (summary) should start in the line  |
|                                       |                                                    |         | immediately after the opening quotes (not in the   |
|                                       |                                                    |         | same line, or leaving a blank line in between)     |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:18  | tracingfuncs.reorderTrace.linearTrace              | GL02    | Closing quotes should be placed in the line after  |
|                                       |                                                    |         | the last text in the docstring (do not close the   |
|                                       |                                                    |         | quotes in the same line as the text, or leave a    |
|                                       |                                                    |         | blank line between the last text and the quotes)   |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:18  | tracingfuncs.reorderTrace.linearTrace              | PR01    | Parameters {'trace_coordinates'} not documented    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:18  | tracingfuncs.reorderTrace.linearTrace              | RT01    | No Returns section found                           |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:89  | tracingfuncs.reorderTrace.circularTrace            | GL01    | Docstring text (summary) should start in the line  |
|                                       |                                                    |         | immediately after the opening quotes (not in the   |
|                                       |                                                    |         | same line, or leaving a blank line in between)     |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:89  | tracingfuncs.reorderTrace.circularTrace            | GL02    | Closing quotes should be placed in the line after  |
|                                       |                                                    |         | the last text in the docstring (do not close the   |
|                                       |                                                    |         | quotes in the same line as the text, or leave a    |
|                                       |                                                    |         | blank line between the last text and the quotes)   |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:89  | tracingfuncs.reorderTrace.circularTrace            | SS03    | Summary does not end with a period                 |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:89  | tracingfuncs.reorderTrace.circularTrace            | SS06    | Summary should fit in a single line                |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:89  | tracingfuncs.reorderTrace.circularTrace            | PR01    | Parameters {'trace_coordinates'} not documented    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:89  | tracingfuncs.reorderTrace.circularTrace            | RT01    | No Returns section found                           |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:186 | tracingfuncs.reorderTrace.circularTrace_old        | GL01    | Docstring text (summary) should start in the line  |
|                                       |                                                    |         | immediately after the opening quotes (not in the   |
|                                       |                                                    |         | same line, or leaving a blank line in between)     |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:186 | tracingfuncs.reorderTrace.circularTrace_old        | GL02    | Closing quotes should be placed in the line after  |
|                                       |                                                    |         | the last text in the docstring (do not close the   |
|                                       |                                                    |         | quotes in the same line as the text, or leave a    |
|                                       |                                                    |         | blank line between the last text and the quotes)   |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:186 | tracingfuncs.reorderTrace.circularTrace_old        | SS03    | Summary does not end with a period                 |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:186 | tracingfuncs.reorderTrace.circularTrace_old        | SS05    | Summary must start with infinitive verb, not third |
|                                       |                                                    |         | person (e.g. use "Generate" instead of             |
|                                       |                                                    |         | "Generates")                                       |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:186 | tracingfuncs.reorderTrace.circularTrace_old        | SS06    | Summary should fit in a single line                |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:186 | tracingfuncs.reorderTrace.circularTrace_old        | PR01    | Parameters {'trace_coordinates'} not documented    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:186 | tracingfuncs.reorderTrace.circularTrace_old        | RT01    | No Returns section found                           |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:225 | tracingfuncs.reorderTrace.loopedCircularTrace      | GL08    | The object does not have a docstring               |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:228 | tracingfuncs.reorderTrace.loopedLinearTrace        | GL08    | The object does not have a docstring               |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:232 | tracingfuncs.genTracingFuncs                       | GL08    | The object does not have a docstring               |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:234 | tracingfuncs.genTracingFuncs.getLocalPixelsBinary  | GL08    | The object does not have a docstring               |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:247 | tracingfuncs.genTracingFuncs.count_and_get_neighbo | GL01    | Docstring text (summary) should start in the line  |
|                                       | urs                                                |         | immediately after the opening quotes (not in the   |
|                                       |                                                    |         | same line, or leaving a blank line in between)     |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:247 | tracingfuncs.genTracingFuncs.count_and_get_neighbo | GL02    | Closing quotes should be placed in the line after  |
|                                       | urs                                                |         | the last text in the docstring (do not close the   |
|                                       |                                                    |         | quotes in the same line as the text, or leave a    |
|                                       |                                                    |         | blank line between the last text and the quotes)   |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:247 | tracingfuncs.genTracingFuncs.count_and_get_neighbo | SS03    | Summary does not end with a period                 |
|                                       | urs                                                |         |                                                    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:247 | tracingfuncs.genTracingFuncs.count_and_get_neighbo | SS05    | Summary must start with infinitive verb, not third |
|                                       | urs                                                |         | person (e.g. use "Generate" instead of             |
|                                       |                                                    |         | "Generates")                                       |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:247 | tracingfuncs.genTracingFuncs.count_and_get_neighbo | SS06    | Summary should fit in a single line                |
|                                       | urs                                                |         |                                                    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:247 | tracingfuncs.genTracingFuncs.count_and_get_neighbo | PR01    | Parameters {'trace_coordinates', 'y', 'x'} not     |
|                                       | urs                                                |         | documented                                         |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:247 | tracingfuncs.genTracingFuncs.count_and_get_neighbo | RT01    | No Returns section found                           |
|                                       | urs                                                |         |                                                    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:280 | tracingfuncs.genTracingFuncs.returnPointsInArray   | GL08    | The object does not have a docstring               |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:305 | tracingfuncs.genTracingFuncs.makeGrid              | GL08    | The object does not have a docstring               |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:317 | tracingfuncs.genTracingFuncs.findBestNextPoint     | GL08    | The object does not have a docstring               |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:342 | tracingfuncs.genTracingFuncs.checkVectorsCandidate | GL01    | Docstring text (summary) should start in the line  |
|                                       | Points                                             |         | immediately after the opening quotes (not in the   |
|                                       |                                                    |         | same line, or leaving a blank line in between)     |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:342 | tracingfuncs.genTracingFuncs.checkVectorsCandidate | GL02    | Closing quotes should be placed in the line after  |
|                                       | Points                                             |         | the last text in the docstring (do not close the   |
|                                       |                                                    |         | quotes in the same line as the text, or leave a    |
|                                       |                                                    |         | blank line between the last text and the quotes)   |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:342 | tracingfuncs.genTracingFuncs.checkVectorsCandidate | SS03    | Summary does not end with a period                 |
|                                       | Points                                             |         |                                                    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:342 | tracingfuncs.genTracingFuncs.checkVectorsCandidate | SS05    | Summary must start with infinitive verb, not third |
|                                       | Points                                             |         | person (e.g. use "Generate" instead of             |
|                                       |                                                    |         | "Generates")                                       |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:342 | tracingfuncs.genTracingFuncs.checkVectorsCandidate | SS06    | Summary should fit in a single line                |
|                                       | Points                                             |         |                                                    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:342 | tracingfuncs.genTracingFuncs.checkVectorsCandidate | PR01    | Parameters {'y', 'ordered_points', 'x',            |
|                                       | Points                                             |         | 'candidate_points'} not documented                 |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+
| topostats/tracing/tracingfuncs.py:342 | tracingfuncs.genTracingFuncs.checkVectorsCandidate | RT01    | No Returns section found                           |
|                                       | Points                                             |         |                                                    |
+---------------------------------------+----------------------------------------------------+---------+----------------------------------------------------+