Skip to content

docs(python-sdk): document retain_async kwarg per #1306#1347

Merged
nicoloboschi merged 2 commits intovectorize-io:mainfrom
r266-tech:docs-python-retain-async-1306
Apr 30, 2026
Merged

docs(python-sdk): document retain_async kwarg per #1306#1347
nicoloboschi merged 2 commits intovectorize-io:mainfrom
r266-tech:docs-python-retain-async-1306

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

#1306 added retain_async: bool = False to client.retain() / client.aretain() so the convenience wrappers reach parity with retain_batch() / aretain_batch() and the TypeScript SDK. The Python SDK doc still documents the kwarg only on retain_batch() (line 93), leaving the new behavior undiscoverable from ### Retain (Store Memory).

This PR adds the same retain_async=False # Set True for background processing line to the existing "With options" example for client.retain(), mirroring the wording used in the retain_batch block right below it (line 93) and in the Node.js SDK doc's retain() example (async: false).

Changes

  • hindsight-docs/docs/sdks/python.md: +1 line in the Retain (Store Memory) "With options" example.
  • skills/hindsight-docs/references/sdks/python.md: same +1 line in the skill mirror.

Notes

@nicoloboschi nicoloboschi merged commit b712f4f into vectorize-io:main Apr 30, 2026
53 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