Skip to content

docs: clarify callbacks for plain-text final answers - #38

Merged
folathecoder merged 1 commit into
lunarstack-co:mainfrom
Ultroncn:docs/plain-text-final-callbacks
Nov 5, 2026
Merged

folathecoder merged 1 commit into
lunarstack-co:mainfrom
Ultroncn:docs/plain-text-final-callbacks

Conversation

@Ultroncn

@Ultroncn Ultroncn commented Nov 5, 2026

Copy link
Copy Markdown

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 FinalEvent for run completion. An unreleased changelog entry records the clarification.

Validation on Python 3.11.17, based on main d78e690c2dd2f27e9de3379481d86447bec8ae27:

  • A scratch ScriptedModel check produced zero callbacks for a plain-text answer and one for a final_answer tool 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.
  • Ruff lint and format checks passed for src, tests and examples.
  • Mypy passed for src, tests and examples, and strict mypy passed for src.
  • uv build and git diff --check passed.

This is a documentation-only change. No runtime behavior changes. Hosted CI has not yet been evaluated.

Prepared with Codex assistance.

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
@folathecoder
folathecoder self-requested a review November 5, 2026 16:27
@folathecoder folathecoder added the documentation Improvements or additions to documentation label Nov 5, 2026
@folathecoder
folathecoder merged commit b28ee4a into lunarstack-co:main Nov 5, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document that step callbacks don't run when the model answers in plain text

2 participants