Skip to content

Clarify docstings of get_volume_positions and get_series_volume_positions #398

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
CPBridge merged 1 commit into from
Mar 18, 2026
Merged

Clarify docstings of get_volume_positions and get_series_volume_positions #398

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
11 changes: 5 additions & 6 deletions src/highdicom/spatial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3505,10 +3505,9 @@ def get_series_volume_positions(
the slice spacing. If the image positions do not represent a
regularly-spaced volume, returns None.
Union[List[int], None]:
List with the same length as the number of image positions. Each
element gives the zero-based index of the corresponding input position
in the volume. If the image positions do not represent a volume,
returns None.
List with the same length as the ``datasets`` input. Each element gives
the zero-based index of the corresponding dataset's position in the
volume. If the image positions do not represent a volume, returns None.

""" # noqa: E501
if len(datasets) == 0:
Expand Down Expand Up @@ -3665,8 +3664,8 @@ def get_volume_positions(
the slice spacing. If the image positions do not represent a
regularly-spaced volume, returns None.
Union[List[int], None]:
List with the same length as the number of image positions. Each
element gives the zero-based index of the corresponding input position
List with the same length as the ``image_positions`` input. Each
element gives the zero-based index of the corresponding image position
in the volume. If the image positions do not represent a volume,
returns None.

Expand Down
Loading