Skip to content

Expand dask_image.imread.imread docstring #411

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

Merged
m-albert merged 1 commit into from
Nov 3, 2025
Merged

Expand dask_image.imread.imread docstring #411

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
4 changes: 2 additions & 2 deletions dask_image/imread/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def imread(fname, nframes=1, *, arraytype="numpy"):
Read image data into a Dask Array.

Provides a simple, fast mechanism to ingest image data into a
Dask Array.
Dask Array. This uses the `pims` package to open images.

Parameters
----------
Expand All @@ -35,7 +35,7 @@ def imread(fname, nframes=1, *, arraytype="numpy"):
Warnings
--------
There are several known issues with this function, and users are
recommended to use `dask.array.image.imread` instead.
recommended to use `dask.array.image.imread` or `bioio` instead.
"""

sfname = str(fname)
Expand Down
Loading