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.

Sign up for GitHub

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

Jump to bottom

DOC Minor fixes to nap 6 doc #233

Merged
merged 3 commits into from Sep 15, 2023
Merged

DOC Minor fixes to nap 6 doc #233

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
66c15d4
fixes
lucyleeow Aug 21, 2023
026a0a3
review, clarify aux contrib
lucyleeow Aug 21, 2023
16ea17b
review
lucyleeow Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/naps/6-contributable-menus.md
View file
Open in desktop
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -238,6 +238,9 @@ Layers
│ ├─ Tracks
│ ├─ Classification
Acquisition
Plugins
Copy link
Contributor

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.

Copy link
Collaborator Author

@lucyleeow lucyleeow Aug 21, 2023 •
edited

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

?

Copy link
Contributor

Choose a reason for hiding this comment

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

yep @lucyleeow that works!


Layers context
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Layers context
Layers Context # already open for contribution

```

As a case study, we take four plugins offering between 9 and 14 widget contributions and arrange their widgets in these menus:
Expand Down