docs: fix stale KDoc in Idna.domainToUnicode and Url.toJavaUrl#144
Open
OmarAlJarrah wants to merge 1 commit into
Open
docs: fix stale KDoc in Idna.domainToUnicode and Url.toJavaUrl#144OmarAlJarrah wants to merge 1 commit into
OmarAlJarrah wants to merge 1 commit into
Conversation
domainToUnicode's KDoc called NFC normalization "(deferred)" even though the function normalizes via Normalizer.nfc three lines below, and the class-level KDoc already documents NFC as fully implemented. toJavaUrl()'s @throws documented MalformedURLException for a not-absolute URI, but on modern JDKs that case throws the unchecked IllegalArgumentException instead, and it's unreachable through this API anyway since every Url's href always carries a scheme. Narrow the @throws to the case that's both correctly typed and reachable: an unregistered protocol handler. Closes #96 Closes #98
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
Idna.domainToUnicode's KDoc called NFC normalization "(deferred)" even though the function normalizes viaNormalizer.nfcthree lines below, and the class-level KDoc already documents NFC as fully implemented.Url.toJavaUrl()'s@throwsdocumentedMalformedURLExceptionfor a not-absolute URI, but on modern JDKs that case throws the uncheckedIllegalArgumentExceptioninstead, and it's unreachable through this API anyway sincetoJavaUrl()istoJavaUri().toURL()and everyUrl'shrefalways carries a scheme. Narrowed the@throwsto the case that's both correctly typed and reachable: an unregistered protocol handler.Test plan
Idna.ktlines ~148-156,JavaNetInterop.ktlines ~22/44/46).Closes #96
Closes #98