Add documentation for syntax nodes and their children #1630
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
ahoppen
reviewed
May 2, 2023
There was a problem hiding this comment.
Thanks a lot. That’s so much better. I have a few suggestions to add illustrative examples, mostly to explain the difference between attributes and modifiers. My thinking is that for many developers using the library, the raw concept of e.g. private is clear and those help map keywords they know to the terms used within SwiftSyntax. If you could apply those, that would be great!
Adds documentation for the following syntax nodes: * AssociatedtypeDeclSyntax * ClassDeclSyntax * ImportDeclSyntax * IsExprSyntax * ProtocolDeclSyntax
whiteio
force-pushed
the
whiteio/add-syntax-node-documentation
branch
from
a80c6a9 to
f33f43a
Compare
|
@ahoppen Thanks for the quick feedback! I've added in your suggestions. |
ahoppen
approved these changes
May 3, 2023
|
@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.
As part of #1528, documentation needs added to some syntax nodes. This PR adds documentation to the following syntax nodes and their children: