Skip to content

Commit e4b487f

Browse files
committed
docs: remove internal TS file/function references from docstrings
1 parent 129045d commit e4b487f

3 files changed

Lines changed: 7 additions & 8 deletions

File tree

src/claude_agent_sdk/_internal/session_resume.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
``~/.claude/``, and returns the path so the caller can point the subprocess at
99
it via ``CLAUDE_CONFIG_DIR``.
1010
11-
Port of the TypeScript SDK's ``materializeResumeSession`` (agentSdk.ts).
11+
Mirrors the behavior of the TypeScript SDK.
1212
"""
1313

1414
from __future__ import annotations
@@ -339,7 +339,7 @@ def _copy_if_present(src: Path, dst: Path) -> None:
339339
def _read_keychain_credentials() -> str | None:
340340
"""Read OAuth credentials JSON from the macOS Keychain (default service name).
341341
342-
Best-effort — returns ``None`` on any error or non-darwin platforms.
342+
Best-effort — returns ``None`` on any error or non-macOS platforms.
343343
"""
344344
# platform.system() (not sys.platform) so mypy doesn't narrow the rest
345345
# of the function to unreachable on the typecheck host.

tests/test_session_resume.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -577,12 +577,11 @@ def spy(*a, **kw):
577577
async def test_non_json_serializable_entry_surfaces_clear_error(
578578
self, cwd: Path, project_key: str, isolated_home: Path
579579
) -> None:
580-
"""Parity with TS: a store returning non-JSON-serializable values
581-
fails materialization with a contextual error and leaves no temp dir.
580+
"""A store returning non-JSON-serializable values fails materialization
581+
with a contextual error and leaves no temp dir.
582582
583-
The TS path serializes via JSON.stringify (which silently drops
584-
functions); Python's json.dumps raises TypeError, which the
585-
materialize wrapper does not catch — assert it surfaces and cleans
583+
Python's json.dumps raises TypeError on non-serializable values; the
584+
materialize wrapper does not catch it — assert it surfaces and cleans
586585
up.
587586
"""
588587

tests/test_transcript_mirror.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def test_too_few_parts_returns_none(self) -> None:
7979

8080
def test_three_parts_returns_none(self) -> None:
8181
# <project_key>/<session_id>/<file>.jsonl is neither main (2 parts)
82-
# nor subagent (>=4 parts) — matches TS reference behavior.
82+
# nor subagent (>=4 parts).
8383
assert (
8484
file_path_to_session_key(_p("proj", "sess", "weird.jsonl"), PROJECTS_DIR)
8585
is None

0 commit comments

Comments
 (0)