docs(checkpoint): mark DeltaChannel and delta-history APIs as beta - #7732
Merged
Merged
Conversation
Adds "Beta" admonitions to the DeltaChannel surface so users can distinguish stable from in-progress contracts: - `DeltaChannel` (langgraph.channels.delta) - `BaseCheckpointSaver.get_delta_channel_history` and async variant - `DeltaChannelHistory` TypedDict - `CheckpointMetadata.delta_updates_since_snapshot` Single-sourced on the base class so subclass overrides in checkpoint-postgres / checkpoint-sqlite / memory inherit the marker via their existing references back to the base. Uses docstring admonitions rather than the `@beta` decorator since these methods are designed to be overridden — wrapping them would emit warnings on every `super()` call.
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.
Summary
Adds a Beta admonition to the
DeltaChannelsurface area so users can distinguish stable from in-progress contracts. Single-sourced on the base class; subclass overrides incheckpoint-postgres/checkpoint-sqlite/ memory inherit the marker via their existing references back to the base.Touched:
DeltaChannel(libs/langgraph/langgraph/channels/delta.py)BaseCheckpointSaver.get_delta_channel_historyandaget_delta_channel_history(libs/checkpoint/.../base/__init__.py)DeltaChannelHistoryTypedDictCheckpointMetadata.delta_updates_since_snapshotWhy docstring admonitions, not
@betaThe base
get_delta_channel_historymethods are designed to be overridden by savers. Wrapping with@beta(fromlangchain_core._api) would emit warnings whenever a subclass calledsuper().get_delta_channel_history(...)or whenever the default ancestor walk fired. Docstring-only keeps the signal advisory and noise-free._DeltaSnapshotis already leading-underscore-private, so it implicitly signals "internal."Versioning note
This intentionally stays a minor bump for the checkpoint releases (4.0 → 4.1, 3.0 → 3.1):
Test plan
make format && make lintclean inlibs/checkpointandlibs/langgraph