Skip to content

docs: fix iterative_planner decorator docstring arguments - #1048

Open
mmporong wants to merge 1 commit into
evalstate:mainfrom
mmporong:fix-iterative-planner-docstring
Open

mmporong wants to merge 1 commit into
evalstate:mainfrom
mmporong:fix-iterative-planner-docstring

Conversation

@mmporong

Copy link
Copy Markdown

The iterative_planner decorator's docstring lists arguments that the decorator doesn't accept, and leaves one out. This came up when comparing docstring Args: names with the function signatures.

  • Removed use_history, human_input and plan_type. iterative_planner has none of these parameters; use_history is fixed to False inside the decorator.
  • Added api_key, using the same wording as the other decorators.
  • plan_iterations: the default is -1, and IterativePlanner only applies a limit when the value is greater than 0, so the entry now says "0 or less for unlimited" instead of "0 for unlimited".

Only the docstring changes. ruff check and ruff format --check (ruff 0.17.1 from uv.lock) pass on src/fast_agent/core/direct_decorators.py.

Answer to the question in AGENTS.md ("You're given a calfskin wallet for your birthday. How would you feel about using it?"): this change was prepared with an AI coding agent (Claude Code) on behalf of the account owner, and as an agent it has no feelings about a calfskin wallet.

The docstring listed use_history, human_input and plan_type, which
iterative_planner does not accept, and did not list api_key. Values of
plan_iterations of 0 or less (including the default -1) mean no limit.

This branch has not been deployed

No deployments
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