Closed K-Meech closed 7 months ago
What is this PR
Why is this PR needed? Docstrings in the general sub-module are currently in reST style.
general
What does this PR do? Converts all docstrings in the general sub-module to numpdoc style.
For https://github.com/brainglobe/brainglobe-utils/issues/19
All tests run locally.
No.
No - docstrings have been updated.
Description
What is this PR
Why is this PR needed? Docstrings in the
general
sub-module are currently in reST style.What does this PR do? Converts all docstrings in the
general
sub-module to numpdoc style.References
For https://github.com/brainglobe/brainglobe-utils/issues/19
How has this PR been tested?
All tests run locally.
Is this a breaking change?
No.
Does this PR require an update to the documentation?
No - docstrings have been updated.
Checklist: