Skip to content

Commit c77cb78

Browse files
committed
Update docstrings
1 parent 1a335a6 commit c77cb78

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

pystac/extensions/raster.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -663,14 +663,17 @@ class RasterExtension(
663663
ExtensionManagementMixin[Union[pystac.Item, pystac.Collection]],
664664
):
665665
"""An abstract class that can be used to extend the properties of an
666-
:class:`~pystac.Item` or :class:`~pystac.Asset` with properties from
666+
:class:`~pystac.Item`, :class:`~pystac.Asset`, or
667+
:class:`~pystac.extension.item_assets.AssetDefinition` with properties from
667668
the :stac-ext:`Raster Extension <raster>`. This class is generic over
668669
the type of STAC Object to be extended (e.g. :class:`~pystac.Item`,
669670
:class:`~pystac.Asset`).
670671
671672
This class will generally not be used directly. Instead, use the concrete
672673
implementation associated with the STAC Object you want to extend (e.g.
673-
:class:`~ItemRasterExtension` to extend an :class:`~pystac.Item`).
674+
:class:`~ItemRasterExtension` to extend an :class:`~pystac.Item`). You may
675+
prefer to use the `ext` class method of this class to construct the correct
676+
instance type for you.
674677
"""
675678

676679
properties: Dict[str, Any]
@@ -769,6 +772,8 @@ def __repr__(self) -> str:
769772

770773
class ItemAssetsRasterExtension(RasterExtension[item_assets.AssetDefinition]):
771774
asset_defn: item_assets.AssetDefinition
775+
"""A reference to the :class:`~pystac.extensions.item_assets.AssetDefinition`
776+
being extended."""
772777

773778
properties: Dict[str, Any]
774779
"""The :class:`~pystac.extensions.item_assets.AssetDefinition` fields, including

0 commit comments

Comments
 (0)