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

Update reader guide to include option to return full Layer objects. #367

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update reader guide to include option to return full Layer objects. #367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _docs/templates/_npe2_readers_guide.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ that accepts a path (`str`) or a list of paths and:
* returns a *new function* (a `ReaderFunction`) that is capable of doing the reading.

The `ReaderFunction` will be passed the same path (or list of paths) and
is expected to return a list of {ref}`LayerData tuples <layer-data-tuples>`.
is expected to return a list containing {ref}`LayerData tuples <layer-data-tuples>` or
a fully instantiated napari `Layer` objects like `Image` or `Labels`.

In the rare case that a reader plugin would like to "claim" a file, but *not*
actually add any data to the viewer, the `ReaderFunction` may return
Expand Down
Loading