Skip to content

Commit c9ea58f

Browse files
authored
Merge pull request #915 from planetlabs/orders-order-305
document list order ordering
2 parents 4c0a62d + ddc616a commit c9ea58f

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

planet/cli/orders.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ async def list(ctx, state, limit, pretty):
6363
6464
This command prints a sequence of the returned order descriptions,
6565
optionally pretty-printed.
66+
67+
Order descriptions are sorted by creation date with the last created order
68+
returned first.
6669
'''
6770
async with orders_client(ctx) as cl:
6871
async for o in cl.list_orders(state=state, limit=limit):

planet/clients/orders.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,10 @@ async def wait(self,
465465
async def list_orders(self,
466466
state: Optional[str] = None,
467467
limit: int = 100) -> AsyncIterator[dict]:
468-
"""Iterate over the list of stored order requests.
468+
"""Iterate over the list of stored orders.
469+
470+
Order descriptions are sorted by creation date with the last created
471+
order returned first.
469472
470473
Note:
471474
The name of this method is based on the API's method name. This

0 commit comments

Comments
 (0)