Skip to content

docs: reconcile stale Todo sections with current state - #403

Merged
twcclegg merged 1 commit into
mainfrom
docs/cleanup-stale-todos
Aug 24, 2026
Merged

docs: reconcile stale Todo sections with current state#403
twcclegg merged 1 commit into
mainfrom
docs/cleanup-stale-todos

Conversation

@twcclegg

Copy link
Copy Markdown
Owner

Summary

  • csharp/README.md: moved the CharSequence divergence out of a vague "Todo" bullet into "Known Issues" (with an actual explanation), matching what CLAUDE.md already claims is documented there. Dropped "Restore the Java logging calls?" — no logging abstraction exists anywhere in this offline library, and none is planned; the question was stale.
  • Root README.md: removed the "ToDo" bullet about porting tests/logging (test porting is already routine practice, e.g. test: port the upstream IsPossibleNumberForType tests #399) and the "How to unfold automatic generated files" ReSharper section, which no longer applies to anything in the repo — locale data moved to binary resources in perf: move the locale country names out of generated C# into binary resources #395, and the one remaining hand-noted generated file (CountryCodeToRegionCodeMap.cs) is already fully formatted (max line length 85, one entry per line).

Test plan

  • dotnet restore csharp && dotnet build csharp --no-restore — clean, 0 warnings/errors (doc-only change, no code touched)

csharp/README.md's "Todo" section duplicated and contradicted the "Known
Issues" section CLAUDE.md points to: the CharSequence divergence was sitting
in "Todo" as a vague one-liner instead of being documented as a known issue,
and "Restore the Java logging calls?" was a stale question — the library has
no logging abstraction anywhere and, being offline with no I/O, isn't adding
one.

Root README.md's "ToDo" ("update / add / port new unit tests ... from java
source") is contradicted by current practice (test porting is already
routine). The ReSharper "unfold automatic generated files" instructions no
longer apply to anything in the repo: locale data moved out of generated C#
into binary resources, and the one remaining hand-noted generated file,
CountryCodeToRegionCodeMap.cs, is already fully formatted (max line length
85, one entry per line) and needs no such cleanup step.
@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.26%. Comparing base (a40ff86) to head (80c8530).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #403   +/-   ##
=======================================
  Coverage   77.26%   77.26%           
=======================================
  Files          39       39           
  Lines        4548     4548           
  Branches     1129     1129           
=======================================
  Hits         3514     3514           
  Misses        783      783           
  Partials      251      251           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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