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

docs: add operation polling example to module docs #2184

Closed
noahdietz opened this issue Sep 25, 2023 · 0 comments · Fixed by #2186
Closed

docs: add operation polling example to module docs #2184

noahdietz opened this issue Sep 25, 2023 · 0 comments · Fixed by #2186
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@noahdietz
Copy link
Contributor

#2178 is an example of our docs missing a proper example of how to handle an Operation returned by an API call. It is not a "live" Operation in that it updates it own state, it needs to be explicitly polled.

So let's add an example to the top level doc.go with some examples.

@noahdietz noahdietz added the type: docs Improvement to the documentation for an API. label Sep 25, 2023
@noahdietz noahdietz self-assigned this Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant