Skip to content

Commit

Permalink
Add option to return full layers
Browse files Browse the repository at this point in the history
  • Loading branch information
DragaDoncila committed Dec 11, 2024
1 parent b2d8b33 commit e0ae2dd
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion _docs/templates/_npe2_readers_guide.md.jinja
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

0 comments on commit e0ae2dd

Please sign in to comment.