Skip to content

Commit f527759

Browse files
committed
documentation fixes
1 parent 4082d79 commit f527759

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

docs/api/extensions.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ pystac.extensions
3030
sar.SarExtension
3131
sat.SatExtension
3232
scientific.ScientificExtension
33-
storage.StorageExtension
33+
storage.StorageSchemesExtension
34+
storage.StorageRefsExtension
3435
table.TableExtension
3536
timestamps.TimestampsExtension
3637
version.VersionExtension

pystac/extensions/storage.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@
2525
from pystac.extensions.hooks import ExtensionHooks
2626
from pystac.utils import StringEnum, get_required, map_opt
2727

28-
#: Generalized version of :class:`~pystac.Item`, :class:`~pystac.Asset` or
29-
#: :class:`~pystac.ItemAssetDefinition`
28+
#: Generalized version of :class:`~pystac.Item`, :class:`~pystac.Catalog` or
29+
#: :class:`~pystac.Collection`
3030
T = TypeVar("T", pystac.Item, pystac.Catalog, pystac.Collection)
31+
#: Generalized version of :class:`~pystac.Asset`, :class:`~pystac.Link` or
32+
#: :class:`~pystac.ItemAssetDefinition`
3133
U = TypeVar("U", pystac.Asset, pystac.Link, pystac.ItemAssetDefinition)
3234

3335
SCHEMA_URI: str = "https://stac-extensions.github.io/storage/v2.0.0/schema.json"
@@ -109,9 +111,9 @@ def create(
109111
type (str): Type identifier for the platform.
110112
platform (str): The cloud provider where data is stored as URI or URI
111113
template to the API.
112-
region (str | None, optional): The region where the data is stored.
114+
region (str | None): The region where the data is stored.
113115
Defaults to None.
114-
requester_pays (bool | None, optional): requester pays or data manager/cloud
116+
requester_pays (bool | None): requester pays or data manager/cloud
115117
provider pays. Defaults to None.
116118
kwargs (dict[str | Any]): Additional properties to set on scheme
117119
@@ -216,13 +218,13 @@ class StorageSchemesExtension(
216218
This class is generic over the type of STAC Object to be extended (e.g.
217219
:class:`~pystac.Item`, :class:`~pystac.Collection`).
218220
219-
To create a concrete instance of :class:`StorageExtension`, use the
220-
:meth:`StorageExtension.ext` method. For example:
221+
To create a concrete instance of :class:`StorageSchemesExtension`, use the
222+
:meth:`StorageSchemesExtension.ext` method. For example:
221223
222224
.. code-block:: python
223225
224226
>>> item: pystac.Item = ...
225-
>>> storage_ext = StorageExtension.ext(item)
227+
>>> storage_ext = StorageSchemesExtension.ext(item)
226228
"""
227229

228230
def apply(
@@ -472,7 +474,7 @@ class SummariesStorageExtension(SummariesExtension):
472474

473475
@property
474476
def schemes(self) -> list[dict[str, StorageScheme]] | None:
475-
"""Get or sets the summary of :attr:`StorageExtension.platform` values
477+
"""Get or sets the summary of :attr:`StorageScheme.platform` values
476478
for this Collection.
477479
"""
478480
v = map_opt(

0 commit comments

Comments
 (0)