Skip to content

Commit

Permalink
Minor doc fix in io module
Browse files Browse the repository at this point in the history
  • Loading branch information
CPBridge committed Jan 26, 2025
1 parent 8d23976 commit dce2644
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/highdicom/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -272,11 +272,11 @@ class ImageFileReader:
----
As of highdicom 0.24.0, users should prefer the :class:`highdicom.Image`
class with lazy frame retrieval (e.g. as output by the
:func:`highdicom.imread` function when `lazy_frame_retrieval=True`) to this
class in most situations. The :class:`highdicom.Image` class offers the
same lazy frame-level access, but additionally has several higher-level
features, including apply pixel transformations to loaded frames,
constructing total pixel matrices, and constructing volumes.
:func:`highdicom.imread` function when ``lazy_frame_retrieval=True``) to
this class in most situations. The :class:`highdicom.Image` class offers
the same lazy frame-level access, but additionally has several higher-level
features, including the ability to apply pixel transformations to loaded
frames, construct total pixel matrices, and construct volumes.
Examples
--------
Expand Down

0 comments on commit dce2644

Please sign in to comment.