docs: correct README's ScopedValue claims (not actually used)#121
Merged
Conversation
CLAUDE.md §3 already records that ScopedValue is not currently used in the codebase — the earlier per-format SerDe caches were torn out. The README still made the present-tense claim in three places (the Java 25 features lede, the concurrency section's heavy-object-reuse bullet, and the thread-safety guidance). Rewrite each to describe the actual state: no ThreadLocal on the hot path because it doesn't compose with thread-per-record, and ScopedValue is the future-tense option if such state is ever introduced.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #121 +/- ##
=========================================
Coverage 70.68% 70.68%
Complexity 623 623
=========================================
Files 68 68
Lines 2521 2521
Branches 323 323
=========================================
Hits 1782 1782
Misses 575 575
Partials 164 164 ☔ View full report in Codecov by Sentry. |
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
CLAUDE.md§3 already records thatScopedValueis not in use in the codebase — the earlier per-format SerDe caches were torn out. The README still claimed otherwise in three places. Rewrite each to describe the actual state.Changes
ScopedValue…"ThreadLocalon the hot path. If thread-local-like state is needed later, reach forScopedValue; the codebase currently has neither."ScopedValue…"ThreadLocal… reach forScopedValueif such state is ever introduced."A
grepagainstlib/**/*.javaconfirms zero usages ofScopedValue. The remaining two mentions in the README are now future-tense ("reach forScopedValue") and accurate.Test plan
ScopedValueimport or reference in production code (verified viagrep -r "ScopedValue" lib/)CLAUDE.md§3 wording matches the corrected README