From 80c8530b85d1d70cf763ad6f79bcb89812332431 Mon Sep 17 00:00:00 2001 From: Thomas Clegg Date: Sun, 23 Aug 2026 23:22:22 -0500 Subject: [PATCH] docs: reconcile stale Todo sections with current state MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- README.md | 10 ---------- csharp/README.md | 12 ++++++------ 2 files changed, 6 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5989a31ff..c018aae36 100644 --- a/README.md +++ b/README.md @@ -169,16 +169,6 @@ Therefore, we recommend you keep this nuget package as up to date as possible us For more information on metadata usage, please refer to the [main repository faq](https://github.com/google/libphonenumber/blob/master/FAQ.md#metadata) -## ToDo - -* update / add / port new unit tests and logging from java source - -## How to unfold automatic generated files - -* Install Jetbrains - Resharper for Visual Studio -* File by file, right click and "Cleanup code" -* Check the unfolded file - ## Running tests locally ```bash diff --git a/csharp/README.md b/csharp/README.md index 9c98b8b6b..56e28ff58 100644 --- a/csharp/README.md +++ b/csharp/README.md @@ -44,9 +44,9 @@ Known Issues and embedded in the assembly. No zip files or text files are needed to run the library or its tests. - -Todo ----- - -- Restore the Java logging calls? -- Find a suitable replace for Java CharSequence in phone numbers parsing API. +- Java's public API accepts `CharSequence` in several entry points (e.g. + `PhoneNumberMatcher`'s constructor, `isViablePhoneNumber`), letting callers pass a `String`, + `StringBuilder`, or `StringBuffer` without copying. The C# port takes `string` in the + equivalent spots (`PhoneNumberMatcher(PhoneNumberUtil, string, ...)`, + `PhoneNumberUtil.IsViablePhoneNumber(string)`) instead of a comparable abstraction, so a + caller building up a number in a `StringBuilder` has to call `.ToString()` first.