brainglobe / brainrender-napari

A napari plugin to render BrainGlobe atlases and associated data as layers.
BSD 3-Clause "New" or "Revised" License
18 stars 1 forks source link

structure -> atlas region #82

Closed alessandrofelder closed 10 months ago

alessandrofelder commented 10 months ago

Description

What is this PR

Why is this PR needed? "Structure" is not intuitive description of "3D brain atlas region mesh"

What does this PR do? Renames variables, docstringstooltips, widget text etc to use "brainatlas region" instead of "structure". docstrings and internal variables preserved to match bg-atlasapi No functionality has been changed (intentionally!).

References

See https://github.com/brainglobe/website/pull/55#discussion_r1304565547

How has this PR been tested?

Tests pass locally and on CI.

Is this a breaking change?

No

Does this PR require an update to the documentation?

This is mainly an improvement to the docs itself.

Checklist:

codecov[bot] commented 10 months ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (706c14a) 97.05% compared to head (0698f00) 97.05%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #82 +/- ## ======================================= Coverage 97.05% 97.05% ======================================= Files 7 7 Lines 339 339 ======================================= Hits 329 329 Misses 10 10 ``` | [Files Changed](https://app.codecov.io/gh/brainglobe/brainrender-napari/pull/82?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe) | Coverage Δ | | |---|---|---| | [brainrender\_napari/utils/load\_user\_data.py](https://app.codecov.io/gh/brainglobe/brainrender-napari/pull/82?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe#diff-YnJhaW5yZW5kZXJfbmFwYXJpL3V0aWxzL2xvYWRfdXNlcl9kYXRhLnB5) | `100.00% <ø> (ø)` | | | [brainrender\_napari/brainrender\_widget.py](https://app.codecov.io/gh/brainglobe/brainrender-napari/pull/82?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe#diff-YnJhaW5yZW5kZXJfbmFwYXJpL2JyYWlucmVuZGVyX3dpZGdldC5weQ==) | `100.00% <100.00%> (ø)` | | | [brainrender\_napari/napari\_atlas\_representation.py](https://app.codecov.io/gh/brainglobe/brainrender-napari/pull/82?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe#diff-YnJhaW5yZW5kZXJfbmFwYXJpL25hcGFyaV9hdGxhc19yZXByZXNlbnRhdGlvbi5weQ==) | `100.00% <100.00%> (ø)` | | | [brainrender\_napari/widgets/brain\_region\_view.py](https://app.codecov.io/gh/brainglobe/brainrender-napari/pull/82?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe#diff-YnJhaW5yZW5kZXJfbmFwYXJpL3dpZGdldHMvYnJhaW5fcmVnaW9uX3ZpZXcucHk=) | `93.38% <100.00%> (ø)` | |

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