docs: clarify usage of name and instructions fields in README
#1331
+2
−1
Conversation
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
ame and instructions in Agent
ame and instructions in README
seratch
requested changes
Jul 31, 2025
README.md
Outdated
| @@ -168,6 +168,13 @@ print(result.final_output) | |||
|
|
|||
| (_For Jupyter notebook users, see [hello_world_jupyter.ipynb](examples/basic/hello_world_jupyter.ipynb)_) | |||
|
|
|||
| ### Note on `name` vs `instructions` | |||
There was a problem hiding this comment.
I don't think having a new section for this on README is the best way to tell this. How about adding a simple line comment to the above code snippet?
seratch
changed the title
name and instructions fields in Agent constructor Fix agent docsname and instructions fields in README
|
it's soo great because instruction is optional and name is required it's soo great idea i also want to do this add |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request improves the documentation by clarifying the difference between the name and instructions parameters in the Agent constructor.
These small additions help new users better understand how to define their agent’s identity and behavior.