Skip to content

Conversation

@KarolinaGroszewska
Copy link
Contributor

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 ♥️

Copy link
Contributor

@kimdv kimdv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@KarolinaGroszewska
Copy link
Contributor Author

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 :)

Copy link
Member

@ahoppen ahoppen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

name: "witnessMethodLabel",
kind: .token(choices: [.keyword(.witness_method)])
kind: .token(choices: [.keyword(.witness_method)]),
documentation: #"The "witnessMethod" label."#
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We generally prefer to use backticks ` instead of " to quote source code. It renders nicer as code font in docc.

Same below

@ahoppen
Copy link
Member

ahoppen commented Mar 22, 2024

Picking this up, addressing my review comment and re-generating files.

@ahoppen
Copy link
Member

ahoppen commented Mar 22, 2024

@swift-ci Please test

@Matejkob
Copy link
Contributor

Picking this up, addressing my review comment and re-generating files.

Haha I was planing to pick it tomorrow as well 😂

@ahoppen ahoppen merged commit bc189ce into swiftlang:main Mar 25, 2024
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.

4 participants