brainglobe / brainglobe-utils

Shared general purpose tools for the BrainGlobe project
MIT License
11 stars 1 forks source link

Convert remaining docstrings to numpydoc style #66

Closed K-Meech closed 5 months ago

K-Meech commented 5 months ago

Description

What is this PR

Why is this PR needed? Some docstrings are still in reST format.

What does this PR do? Updates all remaining docstrings to numpydoc format.

References

For https://github.com/brainglobe/brainglobe-utils/issues/19

How has this PR been tested?

All tests pass locally.

Is this a breaking change?

No

Does this PR require an update to the documentation?

No

Checklist:

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 89.15%. Comparing base (416069a) to head (82c0852).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #66 +/- ## ========================================== + Coverage 89.07% 89.15% +0.07% ========================================== Files 35 35 Lines 1355 1355 ========================================== + Hits 1207 1208 +1 + Misses 148 147 -1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.