Conversation
Sweep comments, docstrings and the client README so they describe what the
code does today rather than how it got there, and stop pointing at internal
docs and systems customers cannot see:
- drop TESTING.md / section-number / appendix references, keeping the
descriptive section names
- replace internal system names with LaunchDarkly-facing ones and drop Jira
keys
- rewrite development-history narration ("used to", "restored from the
pre-rewrite file", "predates this span work", "before this ...") as
statements of current behaviour and the reason for it
No code, runtime strings or assertion messages change.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
XieX
marked this pull request as draft
October 2, 2026 16:23
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
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.
Comment sweep for dev history and references to internal docs etc.
Comment/docstring-only, plus prose in
packages/client/README.md. Every changed.pyfile was checked by parsing old and new with docstrings blanked: the ASTs match, so no code, runtime string or assertion message changed.TESTING.md,§x.ysection numbers andAppendix A.x(none of which exist in this repo). Section-header comments keep their descriptive names.AIC-2948,AIC-2950,AIC-3230).{{message_history}}today, rather than how they used to disagree.References to
TELEMETRY-CONTRACT.mdare kept, since that file ships in this repo.Not changed (runtime string): the assertion message at
packages/langchain-agents/tests/test_handler.py:1512still says(TESTING.md §1.2 Path C).TELEMETRY-CONTRACT.mditself also has some history narration (lines ~615, 647, 659, 674, 711), left for a follow-up.Checks:
uv run ruff check .,uv run ruff format --check .,uv run mypy packages/*/src,uv run pytest(1396 passed, 11 skipped).🤖 Generated with Claude Code, updated by @XieX
Note
Overview
This PR rewrites customer-facing comments, docstrings, and README prose across the Python AI SDK packages so they describe current behavior instead of internal development history, without changing runtime code (per the PR, ASTs match with docstrings blanked).
Documentation hygiene: Removes pointers to non-shipped internals such as
TESTING.md,§x.ysection labels, andAppendix A.xfrom test/module headers and section comments, while keeping descriptive section names. Replaces internal product names (e.g. Gonfalon → LaunchDarkly) and drops Jira ticket references in comments.Tone and content: Converts “used to / pre-span / out of scope” narratives in handlers,
utils, judges, and telemetry-related tests into present-tense invariants (why lazy SDK imports exist, why spans end infinally, judgemessage_historyparity, semconv finish-reason mapping, etc.).TELEMETRY-CONTRACT.mdreferences remain where that file ships with the repo.README: The client
README.mdjudge section now states that all judge paths include input and trajectory viaJudgeTask, rather than describing past path disagreements.Known leftover (not in this diff’s scope per description): one runtime assertion string in
langchain-agentstests still mentionsTESTING.md §1.2 Path C.Reviewed by Cursor Bugbot for commit 88f136a. Bugbot is set up for automated code reviews on this repo. Configure here.