Document and clean up subscriptions client limit behaviour

planetlabs · Oct 24, 2024 · 0960130 · 0960130
1 parent 921a2ba
commit 0960130
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/planet/cli/subscriptions.py b/planet/cli/subscriptions.py
@@ -216,7 +216,8 @@ async def get_subscription_cmd(ctx, subscription_id, pretty):
               'csv_flag',
               is_flag=True,
               default=False,
-              help="Get subscription results as comma-separated fields.")
+              help="Get subscription results as comma-separated fields. When "
+              "this flag is included, --limit is ignored")
 @limit
 # TODO: the following 3 options.
 # –created: timestamp instant or range.
@@ -254,8 +255,7 @@ async def list_subscription_results_cmd(ctx,
     async with subscriptions_client(ctx) as client:
         if csv_flag:
             async for result in client.get_results_csv(subscription_id,
-                                                       status=status,
-                                                       limit=limit):
+                                                       status=status):
                 click.echo(result)
         else:
             async for result in client.get_results(subscription_id,

diff --git a/planet/clients/subscriptions.py b/planet/clients/subscriptions.py
@@ -74,7 +74,7 @@ async def list_subscriptions(self,
                 set, filter out subscriptions with status not in this
                 set.
             limit (int): limit the number of subscriptions in the
-                results.
+                results. When set to 0, no maximum is applied.
             TODO: user_id
 
         Yields:
@@ -270,7 +270,7 @@ async def get_results(self,
             status (Set[str]): pass result with status in this set,
                 filter out results with status not in this set.
             limit (int): limit the number of subscriptions in the
-                results.
+                results. When set to 0, no maximum is applied.
             TODO: created, updated, completed, user_id
 
         Yields:
@@ -310,8 +310,7 @@ async def get_results_csv(
                                           "queued",
                                           "processing",
                                           "failed",
-                                          "success"]]] = None,
-        limit: int = 100,
+                                          "success"]]] = None
     ) -> AsyncIterator[str]:
         """Iterate over rows of results CSV for a Subscription.