Skip to content

docs: rewrite iso2709 + reader comments in declarative terms#99

Merged
dchud merged 1 commit intomainfrom
chore/iso2709-comments-cleanup
Apr 19, 2026
Merged

docs: rewrite iso2709 + reader comments in declarative terms#99
dchud merged 1 commit intomainfrom
chore/iso2709-comments-cleanup

Conversation

@dchud
Copy link
Copy Markdown
Owner

@dchud dchud commented Apr 19, 2026

Summary

Source comments and module docs should describe what the code does and why in timeless terms, not the implementation process that produced them. Earlier comments referenced specific PR identifiers, "the error-enrichment work" (a forward reference to in-progress work on a related bead), and "Currently extracted / Not yet extracted" framing — all of which become noise or actively misleading once the related work lands.

Changes

  • src/iso2709.rs module docstring: replace "Currently / Not yet" framing with a single declarative description of what's in the module and what stays in each reader (and why)
  • src/reader.rs, src/authority_reader.rs, src/holdings_reader.rs: replace three identical comment blocks referencing a specific PR with a single declarative note that the recovery dispatch is unreachable in practice because the read primitive returns a buffer of full length

No code changes; doc-only.

Test plan

  • .cargo/check.sh --quick clean locally
  • Pre-commit hook ran the check on commit
  • CI green on all platforms

🤖 Generated with Claude Code

Source comments and module docs should describe what the code does and
why in timeless terms, not the implementation process that produced
them. Earlier comments referenced "PR1", "the error-enrichment work",
and "Currently extracted / Not yet extracted" — process-state language
that goes stale once the staged work lands.

Replaces:
- Module docstring "Currently extracted / Not yet extracted" framing
  with a single declarative description of what's in the module and
  what stays in each reader (and why)
- Three reader comments referencing "PR1" with a single declarative
  note that the recovery dispatch is unreachable in practice because
  the read primitive returns a buffer of full length

No code changes; doc-only.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dchud dchud self-assigned this Apr 19, 2026
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Apr 19, 2026

Merging this PR will degrade performance by 11.91%

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

❌ 2 (👁 2) regressed benchmarks
✅ 58 untouched benchmarks
⏩ 16 skipped benchmarks1

Performance Changes

Mode Benchmark BASE HEAD Efficiency
👁 WallTime test_process_4_files_parallel_4_threads 89.2 ms 101.3 ms -11.91%
👁 WallTime test_process_8_files_parallel_4_threads 196.9 ms 221.3 ms -11.01%

Comparing chore/iso2709-comments-cleanup (6a474d2) with main (8129ac4)

Open in CodSpeed

Footnotes

  1. 16 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@dchud dchud merged commit 5a7495b into main Apr 19, 2026
48 checks passed
@dchud dchud deleted the chore/iso2709-comments-cleanup branch April 19, 2026 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant