Fix all documentation warnings about mislabeled parameters #2881
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
jaredgrubb
requested review from
DougGregor,
ahoppen and
bnbarham
as code owners
|
When there were two options, I made my best call. Happy to adjust if the reviewers prefer me to use the other option (token/node and stream/target). |
|
@swift-ci Please test |
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.
I was trying to understand one of the macro API and the web documentation was missing the doc I was looking at, so I went to source and saw it was there, but wasn't being used because the name of the parameter was wrong.
I fixed all "not found" documentation warnings in the project. (Note that there are about 1400 more warnings about -missing- parameter documentation, but that's another PR for another day lol)