brainglobe / brainglobe-utils

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

Expand header_widget to include doc path, citation and help text #70

Closed K-Meech closed 5 months ago

K-Meech commented 5 months ago

Description

What is this PR

Why is this PR needed? The header_widget currently doesn't support some of the required features for existing brainglobe headers like cellfinder and brainrender-napari

What does this PR do? This PR adds new features to the header_widget:

References

For https://github.com/brainglobe/cellfinder/issues/327

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?

Relevant docstrings have been updated.

Checklist:

codecov[bot] commented 5 months ago

Codecov Report

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

Project coverage is 90.70%. Comparing base (17e5ebc) to head (3556a72). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #70 +/- ## ========================================== + Coverage 89.07% 90.70% +1.62% ========================================== Files 35 35 Lines 1355 1377 +22 ========================================== + Hits 1207 1249 +42 + Misses 148 128 -20 ```

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

K-Meech commented 5 months ago

Example usage for cellfinder in this draft PR

K-Meech commented 5 months ago

All fixed now @willGraham01 ! Hopefully the PEP overlords are satisfied :laughing:. Feel free to merge if you're happy with it