docs: citation/documentation sweep (PUNY-ccaxoxfa)#21
Merged
Conversation
Cite the standards behaviour we already implement and make the UTS #46 != IDNA2008 distinction explicit. No behaviour change. - normalization-contract.md: new "Standards and references" section mapping each standard to where it is used — RFC 3492 (Punycode transform), RFC 5890 (xn-- ACE framing), RFC 5891 (canonical A-label, cited for that check only), RFC 5892 (ContextJ via CheckJoiners; NOT full CONTEXTO), RFC 5893 (Bidi via CheckBidi), UAX #15 (NFC), UAX #44 (UCD properties), STD 3 = RFC 952+1123 (UseSTD3), RFC 8753 (version pinning). Notes IDNA2003/Nameprep (RFC 3490/3491/3454) as the rejected alternative and the URL-surface citations as scope-conditional. - host_normalize roxygen: spell out "UTS #46 profile, not IDNA2008/RFC 5891 conformance" with the coffee.example example and per-standard pointers. - README: two-tier overview, UTS #46 != IDNA2008 note, host_normalize/ normalization_profile_info added to the feature list, link to the contract. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
Item F of the standards-compliance audit (PUNY-emjvtzlr) — the final subtask. Documentation only — no behaviour change.
Cites the standards behaviour the package already implements and makes the UTS #46 ≠ IDNA2008 distinction explicit everywhere it matters.
docs/normalization-contract.md: new normative Standards and references section mapping each standard to where it is used:xn--ACE framing), RFC 5891 (canonical A-label — cited for that check only, not a conformance claim), RFC 5892 (ContextJ viaCheckJoiners; explicitly NOT full CONTEXTO — CONTEXTO points markedvalidby the mapping table are accepted, which is conformant UTS #46), RFC 5893 (Bidi viaCheckBidi), UAX test: UTS #46 IdnaTestV2 conformance for host_normalize (PUNY-huogtrqn) #15 (NFC), UAX #44 (UCD properties), STD 3 = RFC 952 + RFC 1123 (UseSTD3ASCIIRules), RFC 8753 (version pinning).host_normalize()roxygen: "UTS #46 profile, not IDNA2008 / RFC 5891 conformance" with the☕.example→xn--53h.exampleexample and per-standard pointers.host_normalize()/normalization_profile_info()added to the feature list, link to the contract.Test
devtools::test()→[ FAIL 0 | WARN 0 | SKIP 0 | PASS 375 ]This completes all subtasks (A–F) of the audit umbrella.
🤖 Generated with Claude Code