docs(agent): mark crew attribute as optional in Agent schema#4918
Open
BillionClaw wants to merge 1 commit into
Open
docs(agent): mark crew attribute as optional in Agent schema#4918BillionClaw wants to merge 1 commit into
BillionClaw wants to merge 1 commit into
Conversation
The crew attribute in BaseAgent has default=None, making it optional, but the docstring and documentation table did not indicate this. - Update BaseAgent docstring to show crew (Any | None) - Add crew attribute to agents.mdx documentation table with _(optional)_ marker Fixes documentation inconsistency where crew appeared required but is optional.
|
Friendly bump on this PR — happy to make changes or close it out if it is no longer useful. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
crewattribute inBaseAgenthasdefault=Nonein the Field definition, making it optional. However, the docstring listed it ascrew (Any)without indicating optionality, and it was missing from the documentation table entirely.Changes:
BaseAgentdocstring to showcrew (Any | None)crewattribute to agents.mdx documentation table with_(optional)_markerNote
Low Risk
Documentation-only change that clarifies
BaseAgent.crewcan beNone; no runtime logic is modified.Overview
Clarifies that an agent’s
crewreference is optional.Updates the
BaseAgentdocstring type toAny | Noneand addscrewto the Agents docs attribute table asOptional[Crew]with an optional marker, noting it’s set automatically when added to a crew.Written by Cursor Bugbot for commit 072d65c. This will update automatically on new commits. Configure here.