Do not validate that all parameters have documentation#2963
Merged
bnbarham merged 1 commit intoswiftlang:mainfrom Feb 18, 2025
Merged
Do not validate that all parameters have documentation#2963bnbarham merged 1 commit intoswiftlang:mainfrom
bnbarham merged 1 commit intoswiftlang:mainfrom
Conversation
Member
Author
|
@swift-ci Please test |
This was referenced Feb 10, 2025
bnbarham
approved these changes
Feb 10, 2025
In particular, not all members of syntax nodes have documentation and it is not realistic to add meaningful documentation to all of them in the near future.
ahoppen
force-pushed
the
disable-parameter-validation
branch
from
69c7abe to
f7644b5
Compare
Member
Author
|
@swift-ci Please test |
bnbarham
approved these changes
Feb 13, 2025
ahoppen
added a commit
to ahoppen/github-workflows
that referenced
this pull request
Mar 6, 2025
We need to pass `--disable-parameters-and-returns-validation` to docc validation for swift-syntax because we don’t want to add documentation for all parameters either (see swiftlang/swift-syntax#2963).
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
2 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.
In particular, not all members of syntax nodes have documentation and it is not realistic to add meaningful documentation to all of them in the near future.
Fixes #2961