Docs: clarify purpose of State class #9746
Merged
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
Ujjwal-Bajpayee
requested review from
davidsbatista
and removed request for
a team
Open
|
See #9738 (comment) |
|
|
anakin87
changed the title
|
While this won't fix #9738 (see #9738 (comment)), having a better docstring/API reference for this class won't hurt. @sjrl could you take a look? |
sjrl
reviewed
Aug 28, 2025
sjrl
reviewed
Aug 28, 2025
sjrl
reviewed
Aug 28, 2025
sjrl
reviewed
Aug 28, 2025
anakin87
added
the
ignore-for-release-notes
Pull Request Test Coverage Report for Build 17398848192Details
💛 - Coveralls |
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.
Related Issues
State#9738Proposed Changes:
Expanded the State class docstring to explain its purpose as shared context for Agents and tools
Clarified how schema entries are defined (type, optional handler)
Added a minimal usage snippet for quick understanding
How did you test it?
Manual verification: built and imported the State class to ensure the docstring renders correctly
Notes for the reviewer
This change only affects documentation (no functional changes)
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.