planetlabs / planet-client-python

Python client for Planet APIs
https://planet-sdk-for-python-v2.readthedocs.io/en/latest/
Apache License 2.0
274 stars 92 forks source link

Document and clean up subscriptions client limit behaviour #1071

Closed tbarsballe closed 1 week ago

tbarsballe commented 1 week ago

Related Issue(s):

Closes #1069 Closes #1070

Proposed Changes:

For inclusion in changelog (if applicable):

  1. Removed the unused limit parameter of SubscriptionsClient.get_results_csv

Not intended for changelog:

  1. Added documentation of the limit=0 behaviour to other SubscriptionsClient methods where this is still used(list_subscriptions, get_results)

PR Checklist:

asonnenschein commented 1 week ago

Confirming after reviewing this PR and Subscription API's /results endpoint that limit is undocumented and unused, and I agree that this should be removed.