docs: mark Agent.instructions as optional#3384
Merged
seratch merged 1 commit intoMay 13, 2026
Merged
Conversation
`Agent.instructions` has a default value of `None` (see `src/agents/agent.py:283-290`) and the class docstring itself notes "We strongly recommend passing `instructions`" — implying it is recommended, not required. `Agent(name="x")` succeeds at runtime without `instructions`. Update the property table in `docs/agents.md` to mark it as not-required with a note recommending it.
Member
|
@codex review |
|
Codex Review: Didn't find any major issues. Swish! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
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.
Summary
The Agent properties table in `docs/agents.md` currently marks `instructions` as required (`yes`), but:
Update the table row to mark `instructions` as not required, while keeping a "Strongly recommended" hint to preserve the existing guidance.
Test plan
Docs-only change. Manually verified:
```
$ uv run python -c "from agents import Agent; a = Agent(name='x'); print(a.instructions)"
None
```
Issue number
N/A — found during a docstring/docs accuracy audit.
Checks