fix: transparent static template framing for machine consumption#36
Merged
adaamko merged 2 commits intoJul 13, 2026
Merged
Conversation
Reword DEFAULT_TEMPLATE to clarify output is an unordered list of verbatim excerpts with no synthesis or ranking implied. Update create_simple() default intro consistently. Document static mode as recommended for pipeline/tool-chain use. Closes KRLabsOrg#35
Co-Authored-By: Paperclip <noreply@paperclip.ing>
Contributor
Author
|
Added a small docs readability fix to re-trigger CI. The workflow runs are pending approval from a repo admin — could you approve them? The contribution-rights checkbox is checked in the PR body. Thanks! |
adaamko
approved these changes
Jul 13, 2026
adaamko
left a comment
adaamko
left a comment
Contributor
There was a problem hiding this comment.
Reviewed against #35's acceptance criteria: the default template and create_simple() intro now state plainly that output is an unordered list of verbatim excerpts, and the docs recommend static mode for pipeline use — both criteria met. Verified the diff is minimal and self-contained (no dependency or unrelated changes), and CI is green across 3.10–3.12 with lint and pip-audit. Nice first contribution, thanks @lesbass!
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
2 participants
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
Rewords
StaticTemplate.DEFAULT_TEMPLATEto make explicit that static mode output is an unordered list of verbatim excerpts with no synthesis or ranking implied. The previous wording ("Based on the available documents, here are the key findings") implied a composed answer, which is misleading for machine consumers.Changes
packages/core/verbatim_core/templates/static.py: UpdatedDEFAULT_TEMPLATEandcreate_simple()default intro to use transparent, machine-friendly language.docs/guide/verbatim-core.md: Documented static mode as the recommended choice for pipeline and tool-chain use.Verification
pytest tests/ -v)ruff checkpasses with no issuesRights & sign-off (required)
distributed under the repository's MIT license
(see CONTRIBUTING).
Closes #35