docs: bring the reference in line with the 0.18 API - #151
Merged
Conversation
…as missing
Two of these blocks were not merely incomplete, they were wrong — worse
than absent, because a reader copying them gets a compile error with no
hint why.
- ExecutionLimits (documented twice, in configuration.md and
context-management.md) omitted max_consecutive_identical_tool_calls
and did not mention that the struct is now #[non_exhaustive], so the
literal shown cannot be built from outside the crate.
- CostConfig omitted context_tiers and #[non_exhaustive], and showed a
struct literal. It now documents new() plus the cache builders, with
the reason the rates are not positional: no vendor publishes them in
one order, and a transposed config still passes is_configured.
Newly documented, having shipped with no user-facing docs at all:
- Loop detection — the escalation, the event, why signatures compare
Value rather than text, and that "consecutive" is a deliberate trade
rather than an oversight.
- Retrievable tool output — the marker, the opt-in, block-qualified
keys and why they hash the output, and the two limits that bite
(lossy compaction drops the marker but not the entry; stash entries
are evictable and caller keys are not).
- Context tiers, including the bedrock caveat on deriving prompt size.
README's feature list gained loop detection and retrievable tool output,
and its cost bullet now mentions tiers and the SessionStats rollup.
Every claim checked against the source: the field default, the builder
names, the constant, the struct shape. mdbook builds clean.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Removed from README's license section and from src/agent_loop.rs's module docs, which carried the same line. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Pre-release doc audit. Found two blocks that are wrong, not merely incomplete, and four features shipping with no user-facing docs at all.
Wrong, and worse than absent
A reader copying either of these gets a compile error with no hint why.
ExecutionLimits— documented in two places, both omittingmax_consecutive_identical_tool_callsand both showing a struct literal that no longer compiles outside the crate now that it is#[non_exhaustive]. Now shows the field, the attribute, and thewith_*builders.CostConfig— omittedcontext_tiersand#[non_exhaustive], and showed a struct literal. Now documentsnew()plus the cache builders, with the reason the rates are not positional: no vendor publishes them in one order, and a transposed config still passesis_configured().Shipped undocumented
AgentEvent::LoopDetected, why signatures compareValuerather than serialized text, that within-batch duplicates count, and that consecutive is a deliberate trade (an alternating loop is not detected, because a detector firing on interleaved repeats would be worse than none).bedrock.rscaveat on deriving prompt size.SessionStatsrollup.Verification
Every claim checked against the source rather than from memory — the field default (
Some(3)), the builder names (with_max_consecutive_identical_tool_calls,with_cache_read,with_context_tier), the constant (TOOL_OUTPUT_KEY_PREFIX), and the struct shape (pub context_tiers: Vec<ContextTier>).mdbook buildis clean;SUMMARY.mdis unchanged, so navigation is untouched.Docs only — no code change.
🤖 Generated with Claude Code