Repository navigation
docs: clarify callbacks for plain-text final answers - #38
Merged
folathecoder merged 1 commit intoNov 5, 2026
Merged
Conversation
Explain in the Agent docstring and reference that plain-text final answers skip step callbacks, and point readers to FinalEvent for run completion. Add an unreleased changelog note. Refs lunarstack-co#23
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.
Closes #23.
The Agent docstring and reference did not explain that a plain-text final answer skips step callbacks. Both now state that limit and point readers to
FinalEventfor run completion. An unreleased changelog entry records the clarification.Validation on Python 3.11.17, based on main
d78e690c2dd2f27e9de3379481d86447bec8ae27:ScriptedModelcheck produced zero callbacks for a plain-text answer and one for afinal_answertool call; both produced a final event.uv run pytest tests/test_readme.py -q: 12 passed, 6 skipped.uv run pytest -q: 538 passed, 6 skipped.uv buildandgit diff --checkpassed.This is a documentation-only change. No runtime behavior changes. Hosted CI has not yet been evaluated.
Prepared with Codex assistance.