docs: clarify lifetime and ownership rules for C hook callback parameters#522
Merged
kinyoklion merged 3 commits intomainfrom Apr 15, 2026
Merged
Conversation
Strengthen the documentation in hook.h to make it explicit that all SDK-provided pointers (series_context, data, detail, etc.) must not be retained, cached, or stored beyond the scope of the callback invocation, and that any data needed outside the callback must be copied.
beekld
approved these changes
Apr 13, 2026
Contributor
beekld
left a comment
There was a problem hiding this comment.
I'm curious to hear what prompted the extra warning, but always a good reminder.
LGTM
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.
Strengthen the documentation in hook.h to make it explicit that all SDK-provided pointers (series_context, data, detail, etc.) must not be retained, cached, or stored beyond the scope of the callback invocation, and that any data needed outside the callback must be copied.
Note
Low Risk
Documentation-only updates that clarify ownership/lifetime rules for SDK-provided callback parameters; no runtime behavior changes.
Overview
Adds explicit lifetime/ownership warnings to the C hook API docs (
hook.h), stating that all SDK-provided pointers (series_context,data,detail, etc.) are temporary and must not be retained beyond the callback.Tightens the per-callback
LIFETIME/RETURNSsections to consistently note that any needed data must be copied within the callback and that returnedEvaluationSeriesDataownership transfers to the SDK.Reviewed by Cursor Bugbot for commit 8fb08ab. Bugbot is set up for automated code reviews on this repo. Configure here.