Docs sweep for Map/Set collections — closes #62#339
Merged
Conversation
Fix stale "future collections" language in spec. Update README version and Ch 9 description. Add Map/Set to SKILL.md composite types and common mistakes. Add examples/collections.vera (word-frequency analysis). Remove hardcoded counts from CONTRIBUTING.md. Update example/test counts across docs (25→26). Bump to v0.0.96. Closes #62 Co-Authored-By: Claude <noreply@anthropic.invalid>
📝 WalkthroughWalkthroughVersion bump to v0.0.96 with documentation and test updates reflecting completed Map/Set collections, a new collections example, updated example/conformance counts, adjusted allowlist entries for SKILL.md code blocks, and small test expectation updates. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #339 +/- ##
==========================================
+ Coverage 95.42% 95.43% +0.01%
==========================================
Files 45 45
Lines 15892 15892
==========================================
+ Hits 15165 15167 +2
+ Misses 727 725 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 156-157: The document's conformance program count is inconsistent:
one place states 58 programs ("All 58 conformance programs in
`tests/conformance/`") while the top summary still says 52; update the top
summary (the header/intro count that currently reads 52) to read 58 and scan the
rest of AGENTS.md for any other occurrences of "52" or "58" to make all counts
consistent with the actual number of programs in tests/conformance/.
In `@CLAUDE.md`:
- Around line 96-97: The README/CLAUDE.md contains inconsistent example counts:
the bullet "All 26 examples in `examples/` must pass `vera check` and `vera
verify`" differs from an earlier statement that lists 25 examples; update the
earlier occurrence that mentions "25" so it matches "26" (search for the
sentence or number "25" in CLAUDE.md and change it to "26") ensuring both
statements reference the same example count across the document.
In `@tests/test_verifier.py`:
- Around line 1610-1612: The test's explanatory docstring (starting near the
block that asserts t1 == 145, t3 == 15, total == 160) is out of sync with the
new expected totals; update or trim that narrative so it describes the current
expected values (T1=145, T3=15, total=160) or remove the outdated numeric
example, and ensure any mentions of T1/T3/total within the docstring match the
variables t1, t3, and total used in the assertions.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: dfd35bb7-d4e1-4fd3-b05c-f53e630e798e
⛔ Files ignored due to path filters (5)
docs/index.htmlis excluded by!docs/**docs/index.mdis excluded by!docs/**docs/llms-full.txtis excluded by!docs/**docs/llms.txtis excluded by!docs/**examples/collections.verais excluded by!**/*.vera
📒 Files selected for processing (13)
AGENTS.mdCHANGELOG.mdCLAUDE.mdCONTRIBUTING.mdREADME.mdROADMAP.mdSKILL.mdTESTING.mdpyproject.tomlscripts/check_skill_examples.pyspec/09-standard-library.mdtests/test_verifier.pyvera/__init__.py
Address CodeRabbit review: align conformance count (52→58) in AGENTS.md line 11, example count (25→26) in CLAUDE.md line 66, trim stale tier-count docstring in test_verifier.py, update test_verifier.py line count in TESTING.md, regenerate site assets. Co-Authored-By: Claude <noreply@anthropic.invalid>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
TESTING.md (1)
201-217:⚠️ Potential issue | 🟠 MajorContract coverage figures are stale and internally contradictory.
Line 206 says 7 Tier 3 contracts, but Line 209 says 4 remaining Tier 3 contracts. Also, this section now conflicts with the updated aggregate verifier expectations in
tests/test_verifier.py(145 / 15 / 160). Please update this block to a single source-of-truth set of numbers.💡 Proposed doc fix
-Across all 26 example programs: +Across all 26 example programs: | Metric | Value | |--------|-------| -| **Tier 1 (static)** | 139 contracts — proved automatically by Z3 | -| **Tier 3 (runtime)** | 7 contracts — verified at runtime via assertion checks | -| **Total** | 146 contracts (95.2% static) | +| **Tier 1 (static)** | 145 contracts — proved automatically by Z3 | +| **Tier 3 (runtime)** | 15 contracts — verified at runtime via assertion checks | +| **Total** | 160 contracts (90.6% static) | -The 4 remaining Tier 3 contracts and why they cannot be promoted: +The remaining Tier 3 contracts and why they cannot be promoted:As per coding guidelines: “
**/*.md: Review Markdown files for factual accuracy against the codebase, broken links, and outdated information.” and “TESTING.md: Validation counts and the phrasing of metrics are treated as authoritative… update those to the current totals.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@TESTING.md` around lines 201 - 217, Update TESTING.md so the aggregate contract counts are a single source-of-truth and match the expectations in tests/test_verifier.py (the 145 / 15 / 160 totals referenced in the review), removing the contradictory “7” vs “4 remaining” wording; adjust the summary table (Tier 1/Tier 3/Total) to the values from tests/test_verifier.py and then reconcile the “remaining Tier 3 contracts” list (gc_pressure.vera, generics.vera, increment.vera and any others) so the count and the enumerated examples match the new totals and the verifier test file; ensure any phrasing that implies static vs runtime percentages is updated to reflect the new numbers and that there is only one authoritative block of metrics.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@TESTING.md`:
- Around line 201-217: Update TESTING.md so the aggregate contract counts are a
single source-of-truth and match the expectations in tests/test_verifier.py (the
145 / 15 / 160 totals referenced in the review), removing the contradictory “7”
vs “4 remaining” wording; adjust the summary table (Tier 1/Tier 3/Total) to the
values from tests/test_verifier.py and then reconcile the “remaining Tier 3
contracts” list (gc_pressure.vera, generics.vera, increment.vera and any others)
so the count and the enumerated examples match the new totals and the verifier
test file; ensure any phrasing that implies static vs runtime percentages is
updated to reflect the new numbers and that there is only one authoritative
block of metrics.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: f93464c7-39f3-4892-8552-58aaf7bdb123
⛔ Files ignored due to path filters (1)
docs/llms-full.txtis excluded by!docs/**
📒 Files selected for processing (4)
AGENTS.mdCLAUDE.mdTESTING.mdtests/test_verifier.py
This was referenced Mar 24, 2026
7 tasks
This was referenced May 11, 2026
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.
Summary
PR 3/3 for #62. Documentation sweep and consistency fixes after Map (PR 1) and Set (PR 2) landed.
examples/collections.vera— word-frequency analysis demonstrating Map and Set operationsMap<K, V>andSet<T>to composite types listing; add common mistake for standalonemap_new()/set_new()without type contextCloses #62
Test plan
vera check+vera verifypass on new example🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Tests
Chores