Skip to content

Commit 3999211

Browse files
committed
docs(examples): point Retention sections at delete_session_via_store, not delete_session
delete_session() is the pre-existing sync disk-path helper that os.remove()s the local JSONL and never touches a SessionStore. The async store-backed counterpart that actually calls store.delete() is delete_session_via_store(). A user following the old wording would call delete_session() expecting their S3/Redis/Postgres data to be removed and only the local file would go. Fixes 4 locations: README.md S3/Redis/Postgres Retention sections and the s3_session_store.py module docstring. The corresponding SessionStore Protocol docstring fix is in the base PR.
1 parent fcfdc19 commit 3999211

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

examples/session_stores/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ on your bucket/prefix to expire transcripts according to your compliance
154154
requirements.
155155

156156
`delete()` is implemented (removes all parts for a session) but is only
157-
called when you invoke `delete_session()` from the SDK.
157+
called when you invoke `delete_session_via_store()` from the SDK.
158158

159159
Local-disk transcripts under `CLAUDE_CONFIG_DIR` are swept independently by
160160
the CLI's `cleanupPeriodDays` setting.
@@ -250,7 +250,7 @@ scheduled sweep on your prefix to expire transcripts according to your
250250
compliance requirements.
251251

252252
`delete()` is implemented (cascades to subpath lists and index entries) but is
253-
only called when you invoke `delete_session()` from the SDK.
253+
only called when you invoke `delete_session_via_store()` from the SDK.
254254

255255
Local-disk transcripts under `CLAUDE_CONFIG_DIR` are swept independently by the
256256
CLI's `cleanupPeriodDays` setting.
@@ -367,7 +367,7 @@ table by `mtime`) to expire transcripts according to your compliance
367367
requirements.
368368

369369
`delete()` is implemented (cascades to subpath rows) but is only called when
370-
you invoke `delete_session()` from the SDK.
370+
you invoke `delete_session_via_store()` from the SDK.
371371

372372
Local-disk transcripts under `CLAUDE_CONFIG_DIR` are swept independently by the
373373
CLI's `cleanupPeriodDays` setting.

examples/session_stores/s3_session_store.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
Retention: this adapter never deletes objects on its own. Configure an S3
4040
lifecycle policy on the bucket/prefix to expire transcripts according to your
4141
compliance requirements. :meth:`delete` is implemented but only invoked when
42-
you call ``delete_session()`` from the SDK.
42+
you call ``delete_session_via_store()`` from the SDK.
4343
"""
4444

4545
from __future__ import annotations

0 commit comments

Comments
 (0)