-
Notifications
You must be signed in to change notification settings - Fork 36
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
DOC Minor fixes to nap 6 doc #233
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -69,7 +69,7 @@ not within scope for this NAP, but will be made available to users via a command | |||||
|
||||||
### What is a Menu Contribution? | ||||||
|
||||||
A `MenuItem` contribution in the [`npe2` manifest](https://github.com/napari/npe2/blob/main/npe2/manifest/contributions/_menus.py) | ||||||
A `MenuItem` contribution in the [`npe2` manifest](https://github.com/napari/npe2/blob/main/src/npe2/manifest/contributions/_menus.py) | ||||||
adds a new item to one of the `napari` menus (defined by an ID). When this item is clicked, | ||||||
the associated `command` is executed. Additionally, `enablement` clauses can be defined | ||||||
that control when this menu item is available for clicking and when it is disabled. Similarly, | ||||||
|
@@ -99,9 +99,9 @@ contributions: | |||||
menus: | ||||||
napari/layers/context: | ||||||
- submenu: context_submenu | ||||||
- command: napari-demo.submenu_item | ||||||
hello_world: | ||||||
- command: napari-demo.menu_item | ||||||
context_submenu: | ||||||
- command: napari-demo.submenu_item | ||||||
|
||||||
submenus: | ||||||
- id: context_submenu | ||||||
|
@@ -152,7 +152,7 @@ actions. | |||||
|
||||||
### The `Layers` Menu | ||||||
Currently the foremost example of such an object is the napari `Layers`, and this | ||||||
menu therefore contains five submenus organized by the types of processing | ||||||
top level menu therefore contains five submenus organized by the types of processing | ||||||
the user may wish to perform on the selected `Layer` or `Layers`. | ||||||
|
||||||
The `Layers` submenus are organized to give the user an immediate | ||||||
|
@@ -238,6 +238,9 @@ Layers | |||||
│ ├─ Tracks | ||||||
│ ├─ Classification | ||||||
Acquisition | ||||||
Plugins | ||||||
|
||||||
Layers context | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
``` | ||||||
|
||||||
As a case study, we take four plugins offering between 9 and 14 widget contributions and arrange their widgets in these menus: | ||||||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't add this here as the
Plugins
menu itself is not open for contribution - only the individual plugin's menu within there would be.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, what about expanding to:
Plugins/<my_plugin> # only individual plugins submenu contributable
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yep @lucyleeow that works!