Skip to content

[5.9] Generate grammar doc comments for layout nodes #1836

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

Merged
merged 1 commit into from
Jun 27, 2023

Conversation

ahoppen
Copy link
Member

@ahoppen ahoppen commented Jun 23, 2023

  • Explanation: Add a Children section to the doc comments of syntax nodes that allows you to see the children of the syntax node at a glance in the source order.
  • Scope: Adding doc comments to syntax nodes
  • Risk: Zero, only adds comments
  • Testing: n/a
  • Issue: n/a
  • Reviewer: @bnbarham on Generate grammar doc comments for layout nodes #1771

@ahoppen ahoppen requested a review from bnbarham June 23, 2023 14:02
@ahoppen
Copy link
Member Author

ahoppen commented Jun 23, 2023

@swift-ci Please test

Generate a `Grammar` and a `Children` section as doc-comments for layout nodes.

The `Grammar` section is particularly useful for fairly simple syntax nodes to convey their structure. The `Children` section allows you to see the children of the syntax node at a glance in the source order.
@ahoppen ahoppen force-pushed the ahoppen/5.9/generate-grammar branch from a88c172 to 476b42b Compare June 26, 2023 12:19
@ahoppen
Copy link
Member Author

ahoppen commented Jun 26, 2023

@swift-ci Please test

@ahoppen
Copy link
Member Author

ahoppen commented Jun 26, 2023

@swift-ci Please test Windows

@ahoppen ahoppen merged commit 5879aa3 into swiftlang:release/5.9 Jun 27, 2023
@ahoppen ahoppen deleted the ahoppen/5.9/generate-grammar branch June 27, 2023 18:55
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