Fix typo in doc comment for NavigatorItem.init?(rawValue:) #1340
+1
−1
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
It should be either "Parameters:" (plural) with a nested list of named parameters, or "Parameter x:" (singular).
Member
|
@swift-ci please test |
heckj
approved these changes
Nov 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Fixes a typo in the doc comment that prevented the documentation from rendering correctly in Xcode. I assume this also affects other editors and DocC's rendering, but I haven't tested it in other contexts.
Dependencies
(none)
Testing
I performed no testing other than checking the rendered result in Xcode in the Opt+Click popover.
Thorough testing would involve inspecting the before/after rendering result in DocC itself.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeededI didn't perform any of these steps as this is a simple one-character change in a doc comment. No changes to the code itself.