docs: rewrite iso2709 + reader comments in declarative terms#99
Merged
Conversation
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>
Merging this PR will degrade performance by 11.91%
|
| 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)
Footnotes
-
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. ↩
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
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
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.rsmodule 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 lengthNo code changes; doc-only.
Test plan
.cargo/check.sh --quickclean locally🤖 Generated with Claude Code