Fix StandardQueryValidator initializer doc parameter name.#1892
Open
anxkhn wants to merge 1 commit into
Open
Conversation
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.
Type of Change
Motivation and Context
The doc comment on
StandardQueryValidator.initdocuments a- Parameter delegate:,but the initializer's only parameter is
handler:There is no
delegateparameter (the stored property is alsohandler). A- Parameter <name>that names no real parameter is a documentation defect: DocCwarns on it, and the rendered API docs would show a parameter that does not exist.
This updates the parameter name in the doc comment to match the actual
handlerparameter.
The surrounding prose (the type summary "Pass standard queries to a delegate
handler." and the
answer(query:)comments referring to "the delegate") is leftuntouched: those describe the delegation role in words and are not DocC
- Parameterdirectives, so they are correct as written.Testing
Tested locally
Added/updated tests
Added/updated docs
swift build --target DNSServersucceeds;StandardQueryValidator.swiftcompileswith no diagnostics.
swift format lint --strictreports no issues on the file, andmake fmt(
swift format) is a no-op (no formatting change).No test change: this is a documentation-comment-only edit with no behavioral
effect. The
- Parametername now matches theinit(handler:)signature.Diff (for reference)
1 file changed, 1 insertion(+), 1 deletion(-).