Skip to content

chore: Clarify TrackRequest re-call wording#377

Merged
jsonbailey merged 1 commit into
v7from
jb/aic-2207/clarify-trackrequest-recall-doc
May 15, 2026
Merged

chore: Clarify TrackRequest re-call wording#377
jsonbailey merged 1 commit into
v7from
jb/aic-2207/clarify-trackrequest-recall-doc

Conversation

@jsonbailey
Copy link
Copy Markdown
Contributor

@jsonbailey jsonbailey commented May 14, 2026

Summary

The re-call paragraph added to TrackRequest in #363 overpromised: it said a second call would produce "no additional metric events." That isn't accurate in the partial-failure case -- if the first call's task returns an error before token usage is recorded, the token slot is still empty, and a second successful call will still emit token metric events.

Replaces the inaccurate paragraph with wording that matches the cross-SDK fixes shipped on Ruby, .NET, js-core, and Python.

Test plan

  • CI passes (doc-only change)

Note

Low Risk
Doc-only change that updates TrackRequest semantics for re-calls; no runtime behavior is modified.

Overview
Clarifies the Tracker.TrackRequest doc comment to accurately describe repeated-call behavior: the task may be re-run, and metrics are emitted only for fields not yet recorded on that Tracker (rather than claiming no additional metric events can ever occur).

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

@jsonbailey jsonbailey marked this pull request as ready for review May 14, 2026 16:43
@jsonbailey jsonbailey requested a review from a team as a code owner May 14, 2026 16:43
@jsonbailey jsonbailey changed the title docs: Clarify TrackRequest re-call wording chore: Clarify TrackRequest re-call wording May 15, 2026
@jsonbailey jsonbailey merged commit 66f0ad8 into v7 May 15, 2026
36 checks passed
@jsonbailey jsonbailey deleted the jb/aic-2207/clarify-trackrequest-recall-doc branch May 15, 2026 14:43
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