Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rev python api documentation #994

Open
jreiberkyle opened this issue Jul 18, 2023 · 1 comment
Open

rev python api documentation #994

jreiberkyle opened this issue Jul 18, 2023 · 1 comment

Comments

@jreiberkyle
Copy link
Contributor

jreiberkyle commented Jul 18, 2023

Revise python api documentation to match quality of CLI documentation.

Currently the python api documentation is disjointed from a reader perspective, as it was built up piece by piece as code was written. Revise the documentation to match the CLI story flow, using the same user stories and paths whenever possible.

Some specifics:

  • on the topic of async, keep it simple and focused on the bit of code needed to get the task done (save 'async best practices' story arc for a later effort)
  • when discussing creating, waiting, and downloading an order/asset, be sure to address how bulk ordering may differ from small batch ordering (ref: Download failure under heavy load #974 (comment)_)
@jreiberkyle
Copy link
Contributor Author

planning meeting idea: separate ticket for revising python docs for async calls.

@tbarsballe tbarsballe added this to the V2 Post-Release milestone Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants