Edit user plugin installation page to simplify instructions #586
Conversation
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
github-actions
bot
added
the
documentation
willingc
force-pushed
the
user-plugin
branch
from
c776bfc to
8ffef2d
Compare
6 tasks
TimMonko
reviewed
Feb 20, 2025
docs/plugins/start_using_plugins/finding_and_installing_plugins.md
Outdated
Show resolved
Hide resolved
docs/plugins/start_using_plugins/finding_and_installing_plugins.md
Outdated
Show resolved
Hide resolved
docs/plugins/start_using_plugins/finding_and_installing_plugins.md
Outdated
Show resolved
Hide resolved
docs/plugins/start_using_plugins/finding_and_installing_plugins.md
Outdated
Show resolved
Hide resolved
| ```{admonition} Example | ||
| If you want to install `napari-svg` from a specific release, enter `napari-svg==0.1.0` in the text field. | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Suggested change
| ```{admonition} Installing with Optional Dependency Groups | |
| To install a plugin with a group of option dependencies, use the optional group in brackets. If you want to install `napari-svg` with the optional testing group, enter `napari-svg[testing]` in the text field. | |
| ``` | |
I find this might be the most common use of the test field with users I know -- because optional groups otherwise can't be installed from GUI.
Maybe napari-svg isn't the best example because its only optional is testing. Something like napari-nD-annotator[bbox] might be more informative?
There was a problem hiding this comment.
Adding your existing suggestion to the batch for commit. I think your suggestion about the annotator is a good one. Happy to commit if you add it as a second example.
Co-authored-by: Tim Monko <timmonko@gmail.com>
|
@TimMonko Thanks for the user-focused review suggestions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
References and relevant issues
Closes #224.
Addresses #582.
Together with with #581 improves the user's understanding of plugins, their discovery, and installation.
Description
This PR simplifies the prose using concepts from Google's Docs Style Guide