Add in documentation for AttributeNodes #2302
Conversation
There was a problem hiding this comment.
Welcome @KarolinaGroszewska and thanks for the contribution!
You need to run the code generation.
You simply do it, by navigating to the CodeGeneration folder in the swift-syntax repo. Then you run swift run.
You can read more about it here: https://github.com/apple/swift-syntax/blob/main/CONTRIBUTING.md#generating-source-code
Again, welcome! If any questions, just reach out here and we will help you 😄
|
Alright, managed to run code generation and fix up both the comments and the one error I ran into. Let me know if there's anything else :) |
There was a problem hiding this comment.
Thanks you @KarolinaGroszewska. I have one comment on the comments you added. Other than that, you need to commit the generated files after running code generation.
Also, could you rebase your changes instead of merging main into your branch so that your PR only consists of a single commit?
| @@ -284,15 +285,19 @@ public let ATTRIBUTE_NODES: [Node] = [ | |||
| children: [ | |||
| Child( | |||
| name: "witnessMethodLabel", | |||
| kind: .token(choices: [.keyword(.witness_method)]) | |||
| kind: .token(choices: [.keyword(.witness_method)]), | |||
| documentation: #"The "witnessMethod" label."# | |||
There was a problem hiding this comment.
We generally prefer to use backticks ` instead of " to quote source code. It renders nicer as code font in docc.
Same below
|
Picking this up, addressing my review comment and re-generating files. |
|
@swift-ci Please test |
Haha I was planing to pick it tomorrow as well 😂 |
Add documentation in AttributeNodes.swift file in various locations where it was missing, following the format already within the file.
It's my first time contributing to swift-syntax, so would appreciate as much constructive feedback as y'all can give. Thanks in advance♥️