Skip to content

docs: Update AsyncAgentScheduler docs with new timeout and max_cost parameters#481

Merged
MervinPraison merged 2 commits into
mainfrom
claude/issue-479-20260602-1350
Jun 3, 2026
Merged

docs: Update AsyncAgentScheduler docs with new timeout and max_cost parameters#481
MervinPraison merged 2 commits into
mainfrom
claude/issue-479-20260602-1350

Conversation

@MervinPraison
Copy link
Copy Markdown
Owner

Fixes #479

Summary

Updated AsyncAgentScheduler documentation to reflect new timeout and max_cost parameters from PR #1771.

Changes

  • ✅ Added new Quick Start step showing timeout & budget usage in both scheduler docs
  • ✅ Updated constructor parameter tables with timeout and max_cost descriptions
  • ✅ Added stats response format fields for total_cost_usd and remaining_budget
  • ✅ Created budget-aware scheduling pattern with Mermaid flow diagram
  • ✅ Added budget and timeout best practice accordions
  • ✅ Updated factory function to accept new parameters
  • ✅ Added thread-safety note for jobs server singleton init
  • ✅ Updated CLI scheduler docs with reference to new features

Files Updated

  • docs/features/async-agent-scheduler.mdx
  • docs/features/async-scheduler.mdx
  • docs/features/thread-safety.mdx
  • docs/cli/scheduler.mdx
  • praisonai/scheduler/async_agent_scheduler.py

All changes follow AGENTS.md standards with agent-centric examples, proper Mermaid diagrams using the standard color scheme, and comprehensive coverage of the new budget enforcement and timeout features.

🤖 Generated with Claude Code

…arameters (fixes #479)

- Added new Quick Start step showing timeout & budget usage
- Updated constructor parameter tables with timeout and max_cost descriptions
- Added stats response format fields for total_cost_usd and remaining_budget
- Created budget-aware scheduling pattern with Mermaid flow diagram
- Added budget and timeout best practice accordions
- Updated factory function to accept new parameters
- Added thread-safety note for jobs server singleton init
- Updated CLI scheduler docs with reference to new features

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Mervin Praison <MervinPraison@users.noreply.github.com>
@qodo-code-review
Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 2, 2026

Warning

Review limit reached

@MervinPraison, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 51 minutes and 36 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 41fc8478-6abe-4fe0-b54f-ec87031b3255

📥 Commits

Reviewing files that changed from the base of the PR and between 32b6197 and d313a9b.

📒 Files selected for processing (5)
  • docs/cli/scheduler.mdx
  • docs/features/async-agent-scheduler.mdx
  • docs/features/async-scheduler.mdx
  • docs/features/thread-safety.mdx
  • praisonai/scheduler/async_agent_scheduler.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-479-20260602-1350

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces budget and timeout configurations to the AsyncAgentScheduler class, updating the factory function create_async_agent_scheduler to accept these new parameters (on_success, on_failure, timeout, and max_cost). It also updates the documentation across several files to reflect these new features, including code examples, parameter tables, and a Mermaid diagram. Additionally, a note about thread-safe singleton initialization in the jobs server was added to the thread-safety documentation. Feedback on the code changes suggests removing trailing whitespaces and adding a trailing newline at the end of praisonai/scheduler/async_agent_scheduler.py to comply with PEP 8 standards.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +651 to +659
return AsyncAgentScheduler(
agent,
task,
config,
on_success=on_success,
on_failure=on_failure,
timeout=timeout,
max_cost=max_cost
) No newline at end of file
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

According to the PEP 8 style guide, trailing whitespace should be avoided (W291), and files should always end with a single newline (W292). There are trailing spaces on lines 652, 653, and 654, and the file is missing a newline at the end.

Suggested change
return AsyncAgentScheduler(
agent,
task,
config,
on_success=on_success,
on_failure=on_failure,
timeout=timeout,
max_cost=max_cost
)
return AsyncAgentScheduler(
agent,
task,
config,
on_success=on_success,
on_failure=on_failure,
timeout=timeout,
max_cost=max_cost
)
References
  1. PEP 8: Avoid trailing whitespace (W291) and ensure files end with a single newline (W292). (link)

@MervinPraison MervinPraison merged commit 049e1ec into main Jun 3, 2026
1 check was pending
@MervinPraison MervinPraison deleted the claude/issue-479-20260602-1350 branch June 3, 2026 05:01
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.

docs: Update AsyncAgentScheduler docs with new timeout and max_cost parameters (PR #1771)

1 participant