Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tests for cells sub-module #61

Merged
merged 7 commits into from
Mar 25, 2024
Merged

Add tests for cells sub-module #61

merged 7 commits into from
Mar 25, 2024

Conversation

K-Meech
Copy link
Contributor

@K-Meech K-Meech commented Mar 22, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
The coverage of the cells sub-module is currently only 70%, and there are very few docstrings explaining its functionality.

What does this PR do?

This PR expands the tests and docstrings, bringing the cells sub-module coverage up to 90%.

References

Closes #57
Adds docstrings for #19

How has this PR been tested?

Tests have been updated, and all pass locally.

Is this a breaking change?

No

Does this PR require an update to the documentation?

No

Checklist:

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

@K-Meech K-Meech requested a review from a team March 22, 2024 18:09
Copy link

codecov bot commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.56%. Comparing base (264f849) to head (e5e58e5).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #61      +/-   ##
==========================================
+ Coverage   84.07%   86.56%   +2.49%     
==========================================
  Files          35       35              
  Lines        1331     1355      +24     
==========================================
+ Hits         1119     1173      +54     
+ Misses        212      182      -30     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@alessandrofelder alessandrofelder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good ✨
Some tiny comments - a lot of them are different instances of the same suggestion!

brainglobe_utils/cells/cells.py Outdated Show resolved Hide resolved
tests/tests/test_cells/test_cells.py Show resolved Hide resolved
tests/tests/test_cells/test_cells.py Outdated Show resolved Hide resolved
tests/tests/test_cells/test_cells.py Outdated Show resolved Hide resolved
tests/tests/test_cells/test_cells.py Outdated Show resolved Hide resolved
tests/tests/test_cells/test_cells.py Outdated Show resolved Hide resolved
tests/tests/test_cells/test_cells.py Outdated Show resolved Hide resolved
tests/tests/test_cells/test_cells.py Outdated Show resolved Hide resolved
@K-Meech
Copy link
Contributor Author

K-Meech commented Mar 25, 2024

Thanks @alessandrofelder ! I've added all of your suggestions now - feel free to merge if you're happy with it.

@alessandrofelder alessandrofelder merged commit cacefd6 into main Mar 25, 2024
12 checks passed
@alessandrofelder alessandrofelder deleted the cells_tests branch March 25, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create tests for cells sub-module
2 participants