Add documentation to (nearly) all public functions in the SwiftSyntax module #1670
+307
−42
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
|
@swift-ci Please test |
ahoppen
force-pushed
the
ahoppen/write-documentation
branch
from
3270330 to
2ae353f
Compare
|
Thanks for the review @kimdv. Adding double ticks definitely makes sense. |
|
@swift-ci Please test |
|
@swift-ci please test windows |
kimdv
approved these changes
May 16, 2023
bnbarham
reviewed
May 25, 2023
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.
Nothing more to say, really. Let’s write some documentation. Maybe, eventually, we can enable the swift-format rule that all public declarations must have a doc comment.