Skip to content

Commit

Permalink
Updating doc strings.
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysrevans3 committed Jan 3, 2024
1 parent 0ed5947 commit 9cbce13
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -660,8 +660,11 @@ async def update_collection(
Update a collection.
This method updates an existing collection in the database by first finding
the collection by its id, then deleting the old version, and finally creating
a new version of the updated collection. The updated collection is then returned.
the collection by the id given in the keyword argument `collection_id`.
If no `collection_id` is given the id of the given collection object is used.
If the object and keyword collection ids don't match the sub items
collection id is updated else the items are left unchanged.
The updated collection is then returned.
Args:
collection: A STAC collection that needs to be updated.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -771,7 +771,7 @@ async def update_collection(
Args:
self: The instance of the object calling this function.
collection_id (str): The ID of the collection to be updated.
collection (Collection): The Collection object to be updated.
collection (Collection): The Collection object to be used for the update.
Raises:
NotFoundError: If the collection with the given `collection_id` is not
Expand Down

0 comments on commit 9cbce13

Please sign in to comment.