Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[6.1] Do not validate that all parameters have documentation #2976

Open
wants to merge 1 commit into
base: release/6.1
Choose a base branch
from

Conversation

ahoppen
Copy link
Member

@ahoppen ahoppen commented Feb 24, 2025

  • Explanation: 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. Disable this validation in docc
  • Scope: Verification of swift-syntax’s doc comments, only run in CI
  • Issue: n/a
  • Original PR: Do not validate that all parameters have documentation #2963
  • Risk: None, only runs in CI
  • Testing: Original PR successfully fixed the issue on main
  • Reviewer: @bnbarham

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 ahoppen requested a review from bnbarham as a code owner February 24, 2025 22:51
@ahoppen ahoppen changed the title Do not validate that all parameters have documentation [6.1] Do not validate that all parameters have documentation Feb 24, 2025
@ahoppen
Copy link
Member Author

ahoppen commented Feb 24, 2025

@swift-ci Please test

@ahoppen ahoppen enabled auto-merge February 24, 2025 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants