Skip to content

TPT-2120: Document event and status polling - #1020

Open
zliang-akamai wants to merge 3 commits into
mainfrom
zhiwei/event-poll
Open

TPT-2120: Document event and status polling#1020
zliang-akamai wants to merge 3 commits into
mainfrom
zhiwei/event-poll

Conversation

@zliang-akamai

Copy link
Copy Markdown
Member

📝 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 EventPoller constructor fits common create/mutate flows.

  • New docs/event_and_status_polling.md covering status waits, event pollers, WaitForEventFinished, WaitForResourceFree, configuration, and practical tips
  • README link to the new guide
  • AGENTS.md maintenance notes for keeping that file accurate when repo facts change

✔️ How to Test

Documentation-only change. Review the new guide and README/AGENTS links for accuracy against waitfor.go and account_events.go.

# optional: confirm links resolve in-repo
ls docs/event_and_status_polling.md
grep -n 'event_and_status_polling' README.md

@zliang-akamai
zliang-akamai requested a review from a team as a code owner August 11, 2026 18:29
Copilot AI lite review requested due to automatic review settings August 11, 2026 18:29
@zliang-akamai
zliang-akamai requested a review from a team as a code owner August 11, 2026 18:29
@zliang-akamai zliang-akamai added the documentation for updates to the documentation in the changelog. label Aug 11, 2026
@zliang-akamai
zliang-akamai requested review from jbilskiAkam and mawilk90 and removed request for a team August 11, 2026 18:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, EventPoller constructors, and lower-level event helpers.
  • Linked the new guide from the main README.
  • Added explicit maintenance notes to AGENTS.md about 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.

Comment thread docs/event_and_status_polling.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 WaitForEventFinished still compares both event.Entity.Type and 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
mawilk90 requested review from a team and ezilber-akamai and removed request for a team and jbilskiAkam August 14, 2026 13:59
@zliang-akamai
zliang-akamai requested review from a team and jriddle-linode and removed request for a team August 17, 2026 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation for updates to the documentation in the changelog.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants