TPT-2120: Document event and status polling - #1020
Open
zliang-akamai wants to merge 3 commits into
Open
Conversation
zliang-akamai
requested review from
jbilskiAkam and
mawilk90
and removed request for
a team
August 11, 2026 18:29
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new user-facing documentation guide explaining how to use linodego’s asynchronous “wait” helpers, clarifying when to use status polling vs. account event polling and how to configure polling delay and context deadlines.
Changes:
- Added a new guide covering status waits,
EventPollerconstructors, and lower-level event helpers. - Linked the new guide from the main README.
- Added explicit maintenance notes to
AGENTS.mdabout keeping repository facts up to date.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a link to the new async waiting guide. |
| docs/event_and_status_polling.md | New guide documenting status polling, event polling, configuration, and usage examples. |
| AGENTS.md | Adds a “Maintaining This File” section describing when to update AGENTS.md. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Suppressed comments (1)
docs/event_and_status_polling.md:286
- This describes the fallback as less precise, but
WaitForEventFinishedstill compares bothevent.Entity.Typeand the normalized entity ID locally for every result (waitfor.go:299-330). Only the server-side filtering optimization changes. Please distinguish efficiency from matching accuracy so users do not infer that unsupported entity types can return another resource's event.
- Entity filtering is optimized for disk, database, linode, domain, and nodebalancer entities. Other entity types may be less precise.
mawilk90
approved these changes
Aug 14, 2026
mawilk90
requested review from
a team and
ezilber-akamai
and removed request for
a team and
jbilskiAkam
August 14, 2026 13:59
zliang-akamai
requested review from
a team and
jriddle-linode
and removed request for
a team
August 17, 2026 19:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Description
Adds user-facing guidance for linodego's asynchronous wait helpers so callers know when to use status polling versus event polling, how to configure poll delay and context timeouts, and which
EventPollerconstructor fits common create/mutate flows.WaitForEventFinished,WaitForResourceFree, configuration, and practical tips✔️ How to Test
Documentation-only change. Review the new guide and README/AGENTS links for accuracy against
waitfor.goandaccount_events.go.