Skip to content

Commit 93d687b

Browse files
committed
Fixed builder typing annotations/docstrings
1 parent a4c7519 commit 93d687b

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

plotpy/builder/image.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ def image(
160160
y: numpy.ndarray | None = None,
161161
lut_range: tuple[float, float] | None = None,
162162
lock_position: bool = True,
163-
) -> ImageItem:
163+
) -> ImageItem | XYImageItem | RGBImageItem:
164164
"""Make an image `plot item` from data
165165
166166
Args:
@@ -189,6 +189,7 @@ def image(
189189
190190
Returns:
191191
:py:class:`.ImageItem` object or
192+
:py:class:`.XYImageItem` object if `x` and `y` are specified or
192193
:py:class:`.RGBImageItem` object if data has 3 dimensions
193194
"""
194195
if x is not None or y is not None:
@@ -307,7 +308,7 @@ def maskedimage(
307308
y: numpy.ndarray | None = None,
308309
lut_range: tuple[float, float] | None = None,
309310
lock_position: bool = True,
310-
) -> ImageItem | RGBImageItem:
311+
) -> MaskedImageItem | MaskedXYImageItem:
311312
"""Make a masked image `plot item` from data
312313
313314
Args:
@@ -338,7 +339,7 @@ def maskedimage(
338339
lock_position: lock position. Default is True
339340
340341
Returns:
341-
:py:class:`.MaskedImageItem` object
342+
:py:class:`.MaskedImageItem` object or :py:class:`.MaskedXYImageItem` object
342343
"""
343344
if x is not None or y is not None:
344345
assert pixel_size is None and center_on is None, (
@@ -434,7 +435,7 @@ def maskedxyimage(
434435
zformat: str = "%.1f",
435436
lut_range: tuple[float, float] | None = None,
436437
lock_position: bool = True,
437-
) -> MaskedImageItem:
438+
) -> MaskedXYImageItem:
438439
"""Make a masked XY image `plot item` from data
439440
440441
Args:
@@ -652,7 +653,7 @@ def trimage(
652653
zformat: str = "%.1f",
653654
lut_range: tuple[float, float] | None = None,
654655
lock_position: bool = False,
655-
):
656+
) -> TrImageItem:
656657
"""Make a transformable image `plot item` (image with an arbitrary
657658
affine transform)
658659

0 commit comments

Comments
 (0)