Convert general submodule docstrings to numpydoc - Githubissues

brainglobe / brainglobe-utils

Shared general purpose tools for the BrainGlobe project

MIT License

11 stars 1 forks source link

Convert general submodule docstrings to numpydoc #53

Closed K-Meech closed 7 months ago

K-Meech commented 7 months ago

Description

What is this PR

[ ] Bug fix
[ ] Addition of a new feature
[X] Other

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:

[X] The code has been tested locally
[X] Tests have been added to cover all new functionality (unit & integration)
[X] The documentation has been updated to reflect any changes
[X] The code has been formatted with pre-commit