Skip to content

Commit 3c653c1

Browse files
authored
Clarify docstings of get_volume_positions and get_series_volume_positions (#398)
1 parent ab9dd67 commit 3c653c1

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

src/highdicom/spatial.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3505,10 +3505,9 @@ def get_series_volume_positions(
35053505
the slice spacing. If the image positions do not represent a
35063506
regularly-spaced volume, returns None.
35073507
Union[List[int], None]:
3508-
List with the same length as the number of image positions. Each
3509-
element gives the zero-based index of the corresponding input position
3510-
in the volume. If the image positions do not represent a volume,
3511-
returns None.
3508+
List with the same length as the ``datasets`` input. Each element gives
3509+
the zero-based index of the corresponding dataset's position in the
3510+
volume. If the image positions do not represent a volume, returns None.
35123511
35133512
""" # noqa: E501
35143513
if len(datasets) == 0:
@@ -3665,8 +3664,8 @@ def get_volume_positions(
36653664
the slice spacing. If the image positions do not represent a
36663665
regularly-spaced volume, returns None.
36673666
Union[List[int], None]:
3668-
List with the same length as the number of image positions. Each
3669-
element gives the zero-based index of the corresponding input position
3667+
List with the same length as the ``image_positions`` input. Each
3668+
element gives the zero-based index of the corresponding image position
36703669
in the volume. If the image positions do not represent a volume,
36713670
returns None.
36723671

0 commit comments

Comments
 (0)