brainglobe / brainglobe-utils

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

Delete unused code & add tests #18

Closed adamltyson closed 10 months ago

adamltyson commented 10 months ago

Description

What is this PR

Why is this PR needed? There is a lot of code in this repo that is no longer used by any BrainGlobe tool. Keeping it in the repo increases the maintenance burden.

What does this PR do? Removes unused code and adds some more tests for what remains.

Also closes #12

How has this PR been tested?

Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.

Is this a breaking change?

Hopefully not. I've checked other BG repos for usage of deleted code, and nothing came up. This process isn't foolproof though, so we may just have to release and hope for the best! This is a fairly dangerous approach, so happy to hear of alternatives.

Does this PR require an update to the documentation?

If any features have changed, or have been added. Please explain how the documentation has been updated (and link to the associated PR). See here for details.

Checklist:

codecov[bot] commented 10 months ago

Codecov Report

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

Comparison is base (b009106) 64.04% compared to head (79f6a88) 79.68%.

:exclamation: Current head 79f6a88 differs from pull request most recent head 03f1c2d. Consider uploading reports for the commit 03f1c2d to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #18 +/- ## =========================================== + Coverage 64.04% 79.68% +15.63% =========================================== Files 33 19 -14 Lines 840 576 -264 =========================================== - Hits 538 459 -79 + Misses 302 117 -185 ```

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

adamltyson commented 10 months ago

@willGraham01 I've raised https://github.com/brainglobe/brainglobe-utils/issues/19 Adding docstrings is something the entirety of BG sorely needs.

adamltyson commented 10 months ago

Thanks both. Going to release a new version, so yell at me if anything breaks!