simukappu / agentverify / 24893886890

100%

main: 100%

push

github

docs: polish README — add Cost Assertions section, fold Quick Start subtitle, unify H3 title case

Second pass on the README after the Real-World Examples reshuffle.
Surface-level cleanups and one small section addition, driven by a
top-to-bottom re-read of the file.

Structural:

- Drop the "Why agentverify?" H2 and fold its body directly under
  the tagline so the opening flows as one continuous pitch, then
  add a "Who is this for?" H2 with five concrete reader-pain
  bullets before Install.
- Add a dedicated "Cost Assertions" subsection under Assertion
  Modes, placed before "Latency Assertions" to match the order
  used in Quick Start, the `assert_all` example, and the Error
  Messages samples.
- Fold "— No LLM Required" out of the Quick Start heading into
  its opening sentence.
- Fold "— Test Routing Without an LLM" out of the Tool Mocking
  heading into its opening sentence.
- Rename "Request Matching (Stale Cassette Detection)" to
  "Stale Cassette Detection" and rephrase its opener to lead
  with *why* the check exists rather than *what* it does.
- Rename the H3 "How do cassettes age in practice?" to a
  declarative "Keeping Cassettes Current".
- Unify all H3 headings to title case
  ("Assert Step-to-Step Data Flow", "Workflow-Style Agents with
  `step_probe`", "When to Use MockLLM vs Cassettes").

Copy:

- Rewrite the "Near-term:" roadmap bullets with a one-line mission
  statement that keeps the ambition but drops the bolder
  "pytest for Python" comparison.
- Rewrite "Who is this for?" to stay punchy without venting at
  the reader ("looks fine locally" is now an "informal signoff",
  not a Slack dig).
- Soften the "walks the multi-line feedback into..." phrasing in
  the OpenAI Agents example — `assert_step_uses_result_from` now
  *finds* the feedback *inside* the next step.
- Replace "Legacy v0.2.0 form" for flat `tool_calls` in the
  `ExecutionResult.from_dict` table with "Shortcut for
  single-step cases", which matches how the Quick ... (continued)

389 of 389 branches covered (100.0%)

Branch coverage included in aggregate %.

1915 of 1915 relevant lines covered (100.0%)

1.0 hits per line