jni / zarpaint

Paint segmentations directly to on-disk/remote zarr arrays
BSD 3-Clause "New" or "Revised" License
14 stars 8 forks source link

Migrate to npe2 #20

Closed jamesyan-git closed 2 years ago

jamesyan-git commented 2 years ago

This PR adds the necessary metadata to convert npe2 and removes mentions of hook implementations. Additionally moved all imports form plugin.py to init and kept reader separate (now found in reader.py)

codecov-commenter commented 2 years ago

Codecov Report

Merging #20 (fa0765e) into main (3036037) will decrease coverage by 1.03%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #20      +/-   ##
==========================================
- Coverage   52.04%   51.01%   -1.04%     
==========================================
  Files           9        9              
  Lines         415      396      -19     
==========================================
- Hits          216      202      -14     
+ Misses        199      194       -5     
Impacted Files Coverage Δ
zarpaint/__init__.py 77.77% <100.00%> (+2.77%) :arrow_up:
zarpaint/_tests/test_dock_widget.py 100.00% <100.00%> (ø)
zarpaint/reader.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update df619a4...fa0765e. Read the comment docs.

DragaDoncila commented 2 years ago

Either way, I prefer "Action..." as the menu bar title for an item to "Create Action".

@jni just to clarify. The title of a command is what would show up if you were to say, search for it through a VSCode like command palette. So they should stay stuff like "Open segmentation widget". The display_name of a Widget contribution is what comes up in the menu bar, so it should say something like "Segment with watershed".

Eventually the commands might stand alone to perform other actions, and I feel like this will make more sense then.

deprecated-napari-hub-preview-bot[bot] commented 2 years ago

Preview page for your plugin is ready here: https://preview.napari-hub.org/jni/zarpaint/20

deprecated-napari-hub-preview-bot[bot] commented 2 years ago

Preview page for your plugin is ready here: https://preview.napari-hub.org/jni/zarpaint/20

jni commented 2 years ago

@DragaDoncila thanks for the clarifications!

So they should stay stuff like "Open segmentation widget".

I actually disagree with this. I think it should still say "Segment with watershed…". No one is using napari to open widgets, they are using it to achieve specific visualisation, annotation, and analysis goals, and the commands should be named in a way that guides users towards those goals.

The "…" is important as it signifies that this command will take further input, see Apple's Human Interface Guidelines on menu item titles. I guess for now all commands have an ellipsis. Once direct commands are supported, we can remove the ellipses where needed.

Use an ellipsis whenever choosing a menu item requires additional input from the user. The ellipsis character (…) means a dialog or separate window will open and prompt the user for additional information or to make a choice.

I don't see a need to distinguish commands from the command palette and menu bar items in this regard: both cause the same effect.

As an aside, we should probably codify this in npe2 plugin best practices somewhere...

Based on this I'll push some preferred menu item titles directly to this branch and merge. Thanks @jamesyan-git! Onward and upward! :smiley:

deprecated-napari-hub-preview-bot[bot] commented 2 years ago

Preview page for your plugin is ready here: https://preview.napari-hub.org/jni/zarpaint/20