style(tracing/nodestats): Fix all numpydoc-validation errors

AFM-SPM / TopoStats

An AFM image analysis program to batch process data and obtain statistics from images

https://afm-spm.github.io/TopoStats/

GNU Lesser General Public License v3.0

60 stars 11 forks source link

style(tracing/nodestats): Fix all numpydoc-validation errors #937

Closed ns-rse closed 1 month ago

ns-rse commented 1 month ago

Resolves #919

This is a combination of 6 commits which were squashed via interactive rebasing...

style(tracing/nodestats): PR02 numpydoc-validation
style(tracing/nodestats): RT01 numpydoc-validation
style(tracing/nodestats): GL01 nupydoc-validation
style(tracing/nodestats): GL02/GL03 numpydoc-validation
style(tracing/nodestats): PR03 numpydoc-validation
style(tracing/nodestats): PR01/PR07 numpydoc-validation

ns-rse commented 1 month ago

I must have wondered why it passed it first time 😂

Check the change to pyproject.toml (the file was deliberately excluded from being checked as it originally had virtually no docstrings at all and I had no idea what they did, same is true of tracingfuncs.py). This refactoring work has rounded it out nicely though.