Skip to content

AGE-1122: Align public API docstrings across agent SDK code#6

Merged
chiragjn merged 2 commits into
mainfrom
AGE-1122
Jul 1, 2026
Merged

AGE-1122: Align public API docstrings across agent SDK code#6
chiragjn merged 2 commits into
mainfrom
AGE-1122

Conversation

@bhaveshpatel640

@bhaveshpatel640 bhaveshpatel640 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

AGE-1122: Align public API docstrings across manual agent SDK code


Note

Low Risk
Documentation-only changes with no logic, types, or wire behavior modified.

Overview
Adds NumPy-style docstrings across the manual agent SDK surface so public APIs document parameters, return types, and streaming behavior consistently.

Coverage spans sync and async paths: AgentSession / AsyncAgentSession, AgentSessionClient, PreparedTurn / AsyncPreparedTurn, Turn / AsyncTurn, delta helpers in event_delta, TurnStreamData, and the gateway agents accessors on TrueFoundryGateway / AsyncTrueFoundryGateway. Several one-line docstrings on methods like refresh and stream are expanded to the same Parameters / Returns / Yields pattern, including notes on pagination, request_options, SSE resume via after_sequence_number, and when turn fields are available before vs after execute().

No runtime or API behavior changes—documentation only.

Reviewed by Cursor Bugbot for commit f13752a. Bugbot is set up for automated code reviews on this repo. Configure here.

@bhaveshpatel640 bhaveshpatel640 force-pushed the AGE-1122 branch 2 times, most recently from 51a4b79 to bfb7cf4 Compare July 1, 2026 08:51
@bhaveshpatel640 bhaveshpatel640 changed the title AGE-1122: Align public API docstrings across manual agent SDK code AGE-1122: Align public API docstrings across agent SDK code Jul 1, 2026
@chiragjn chiragjn merged commit 287f429 into main Jul 1, 2026
4 checks passed
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.

2 participants