docs: demote URL surface to best-effort host extraction (PUNY-gfjkdjol)#19
Merged
Merged
Conversation
Re-document url_encode/url_decode/parse_url as best-effort host extraction and rewriting in URL-shaped strings — explicitly NOT RFC 3986 / WHATWG URL parsing or canonicalization. State the non-goals (percent encoding/decoding, scheme/port/path semantics, full IPv6 incl. zone IDs / RFC 6874, serialization) and note the surface is slated for eventual removal in favour of a dedicated URL package (rurl) consuming punycoder's host functions. Updated roxygen, DESCRIPTION, and README (.Rmd + rendered .md). Phase 1 only; deprecation/removal is a separate follow-up ticket. No behaviour change. 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
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.
What
Item C (phase 1) of the standards-compliance audit (PUNY-emjvtzlr). Documentation only — no behaviour change.
punycoder_url.cppis a hand-rolled splitter, not an RFC 3986 / WHATWG URL parser. This re-documents the URL surface honestly so nobody mistakes it for URL canonicalization (which isrurl's mission, and was the source of the oldrurl↔punycodercircular dependency).url_encode/url_decode/parse_url): reframed as "best-effort host extraction and rewriting, NOT URL parsing or canonicalization"..Rmd+ rendered.md) updated to match;parse_urldoc notes the surface is slated for eventual removal in favour ofrurlconsuming punycoder's host functions.Out of scope
Phase 2 (deprecation + removal of
url_*/parse_url/punycoder_url.cpp) is a separate follow-up ticket with its own deprecation cycle.Test
devtools::test()→[ FAIL 0 | WARN 0 | SKIP 0 | PASS 375 ]🤖 Generated with Claude Code