Conversation
github-actions
bot
added
the
documentation
| - Support for reader plugins [#937](https://github.com/napari/napari/pull/937) and writer plugins [#1068](https://github.com/napari/napari/issues/1068) to allow **viewing of domain-specific data and saving of annotations**. For more details see the [`plugins` label](https://github.com/napari/napari/labels/plugins) on our repository. | ||
|
|
||
| > We have a stable specification for adding both [reader and writer plugins](hook-specifications-reference) that is being used in the community. | ||
| > We have a stable specification for adding both reader and writer plugins that is being used in the community. |
There was a problem hiding this comment.
Docs wouldn't build using my branch from napari/napari#8622 without removing this, so I've removed it. Not sure if there's a better way to handle a historical reference like this.
There was a problem hiding this comment.
You could hard-link it using a full URL, since it doesn't need to update with new versions... But IMO this is fine, we don't really need people to go here.
| | canvas | The canvas in the center of napari viewer contains the visual display of the data passed to napari, including images, points, shapes, and other supported data types. | | | ||
| | channel | A channel is an image where each pixel only contains its intensity value (i.e. grayscale image). In fluorescence microscopy, each channel corresponds to a range of wavelengths. An RGB image from digital camera consists of 3 channels - red, green, blue (RGB). In napari, an image dimension that is not spatial or temporal can be considered as channels, and is typically represented as individual [image layer](layers-image). See also [this wiki page](<https://en.wikipedia.org/wiki/Channel_(digital_image)>) for specific examples. | raster band in geoscience | | ||
| | colormap | A colormap represents the value of each pixel as a particular color. In fluorescence microscopy, the colormap can be selected to mirror the color of the collected wavelength. In other applications, colormaps can be used to provide the visual representation of the measured signal. There are many different types of colormaps available, see [choosing colormaps in matplotlib](https://matplotlib.org/stable/tutorials/colors/colormaps.html). | look up table, LUT | | ||
| | event | Events and connections are a way to tell napari "If this event occurs, then call this function". [Hooking up your own events](connecting-events). | | |
There was a problem hiding this comment.
Maybe we want to keep these (without the reference links) for historical reasons? But I didn't think it was worth it.
|
Hmm I don't understand why it says |
|
Drat, the other failure is about a missing hookspec in a docstring. I remove that line in napari/napari#8579... So I guess we need to:
|
search for napari-plugin-template in the docs? a label is another word for a link. It's a labeled link. So I suspect you've deleted the place where the label was defined but you are still linking to it. I think? |
Yes I think you have the order of operations right |
|
Sounds like the right plan @DragaDoncila |
|
@napari-bot make html |
brisvag
left a comment
brisvag
left a comment
There was a problem hiding this comment.
Some suggestions, but otherwise good!
| see below and the [Publishing](plugin-deploy) guide for more details. | ||
|
|
||
| (napari-plugin-template)= | ||
|
|
There was a problem hiding this comment.
@brisvag I added this here on purpose because we otherwise have nowhere to point people to the template. This label is used in a couple of spots. I'd be open to adding a different, better section on the template elsewhere, but for now I thought it was better to go here than nowhere.
Although I note now that we refer to the template explicitly by full URL in other places, so maybe we just do that everywhere? idk
There was a problem hiding this comment.
Uhm, I deleted only the white space I think, or is the suggestion wrong? Anyways, it was just an aesthetic suggestion, not to remove the reference :)
Co-authored-by: Lorenzo Gaifas <[email protected]>
4 participants
References and relevant issues
Partially addresses napari/napari#8447
Description
This PR removes references to the napari plugin engine, hook specifications, and npe1 generally. I've removed the hook specification reference entirely (it'll still be available on old docs versions). I've kept the migration guide more-or-less unchanged, so folks should still have all the info they need to update their plugins. I've also updated various examples using hook specifications to use the npe2-style contributions.