Skip to content

docs: update BRC timeout wait for event-driven polling [doc-updater] - #1934

Merged
jwbron merged 2 commits into
mainfrom
egg/doc-update-brc-timeout-polling
Apr 23, 2026
Merged

docs: update BRC timeout wait for event-driven polling [doc-updater]#1934
jwbron merged 2 commits into
mainfrom
egg/doc-update-brc-timeout-polling

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

Update documentation to reflect changes from 7e2f999 (#1929):

Triggered by: #1929

Issue: none

Test Plan

  • Automated: doc-only change, no code tests affected
  • Manual: verify line 704 of docs/guides/concurrent-execution.md
    accurately describes the event-driven polling behavior

Authored-by: egg

@egg-reviewer egg-reviewer Bot 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.

Doc-only change, single line in docs/guides/concurrent-execution.md. Verified every claim against the merged implementation in orchestrator/routes/pipelines.py (from #1929 / 7e2f999):

  • "event-driven polling loop": confirmed — while remaining: loop at :8443
  • "30-second intervals": matches post_timeout_poll_interval = 30 at :8440
  • "up to 3600s total budget": matches post_timeout_budget = 3600 at :8439
  • "rechecks consensus proactively on each iteration": executor.check_consensus() at :8452
  • "immediately stops remaining containers": _stop_running_containers() at :8481
  • "marks agents complete, restores pipeline, returns success": :8480-8482
  • "replaces the former per-container blocking wait": ThreadPoolExecutor + wait_for_container removed in #1929
  • Issue references: #1921 (polling refactor) added, #1693 (HITL escalation) preserved — both correct

No issues.

One non-blocking note: line 704 is now ~580 characters of unbroken text. Consider splitting it into a short intro sentence followed by a bulleted list of the polling mechanics for readability. Not blocking on this.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

This comment has been minimized.

@james-in-a-box james-in-a-box Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Agreed. Split the ~580-character paragraph on line 704 into a short intro sentence followed by a bulleted list (polling mechanics, consensus-complete behavior, unresolved-NACKs escalation). The historical context note about #1921 is now a standalone sentence after the list.

— Authored by egg

@egg-reviewer egg-reviewer Bot 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.

Re-reviewed the delta since 745bdead (one new commit: 7c3184b).

The feedback-addressing commit correctly splits the ~580-character paragraph into a bulleted list as suggested. Verified:

  • No content lost: all claims from the first commit preserved — polling mechanics (30s / 3600s budget), consensus-complete recovery path, NACK escalation path, and historical context about #1921.
  • Formatting clean: intro sentence with colon, three bullets, standalone closing paragraph. Integrates well with surrounding sections (lines 702–712).
  • Issue references intact: #1921 and #1693 both preserved and correctly placed.

No issues.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

2 previous review(s) hidden.

@jwbron
jwbron merged commit 95b5031 into main Apr 23, 2026
26 checks passed
james-in-a-box Bot added a commit that referenced this pull request Apr 24, 2026
…1934)

* docs: update BRC timeout wait description for event-driven polling

* docs: split long timeout-wait paragraph into bulleted list for readability

---------

Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com>
Co-authored-by: egg-reviewer[bot] <261018737+egg-reviewer[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant