Skip to content

docs: document relative_path parameter in MultiStepAgent.save() - #2567

Open
LuShadowX wants to merge 1 commit into
huggingface:mainfrom
LuShadowX:docs/document-save-relative-path
Open

docs: document relative_path parameter in MultiStepAgent.save()#2567
LuShadowX wants to merge 1 commit into
huggingface:mainfrom
LuShadowX:docs/document-save-relative-path

Conversation

@LuShadowX

Copy link
Copy Markdown

What does this PR do?

MultiStepAgent.save() accepts a relative_path argument, but its docstring's Args section only documented output_dir, leaving relative_path undocumented.

This PR adds an Args entry for relative_path, explaining that it sets the dotted module-path prefix used when recursively saving managed agents, so the import paths in the generated files (e.g. app.py) reflect the agent hierarchy. Top-level callers leave it as None.

Documentation-only change — no functional or behavioral impact.

Before / After

Before:

Args:
    output_dir (`str` or `Path`): The folder in which you want to save your agent.

After:

Args:
    output_dir (`str` or `Path`): The folder in which you want to save your agent.
    relative_path (`str`, *optional*): Dotted module path prefix locating this agent within a hierarchy of managed agents. ...

Before submitting

  • Documentation-only improvement.
  • Followed the docstring style used elsewhere in the file (`type`, *optional*).
  • Read the contributor guidelines.

`save()` accepts a `relative_path` argument, but its docstring only
documented `output_dir`. Add an `Args` entry for `relative_path`, which
sets the dotted module-path prefix used when recursively saving managed
agents so the import paths in generated files reflect the agent hierarchy.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.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