Add a documentation article for @_spi and when to use existentials
#1696
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
Also remove the `Create SwiftSyntax Release.md` because it describes how to vendor the parser library and we’re no longer doing that.
|
@swift-ci Please test |
kimdv
approved these changes
May 23, 2023
ahoppen
changed the title
@_spi@_spi and when to use existentials
kimdv
reviewed
May 23, 2023
There was a problem hiding this comment.
Maybe usage of double ticks would make sense?
ahoppen
force-pushed
the
ahoppen/document-spi
branch
from
91e12ce to
d4d4a70
Compare
TTOzzi
reviewed
May 23, 2023
bnbarham
reviewed
May 23, 2023
| @@ -0,0 +1,10 @@ | |||
| # When to use protocols in SwiftSyntax | |||
|
|
|||
| Learn when to use protocols value types like ``ExprSyntax`` over protocols like ``ExprSyntaxProtocol``. | |||
There was a problem hiding this comment.
I don't feel like this line (and the one in the other file) add much beyond the title itself.
There was a problem hiding this comment.
I agree. But docc renders this as the abstract of the article and without this the entire next paragraph becomes the abstract, which looks ugly.
bnbarham
reviewed
May 23, 2023
Sources/SwiftSyntax/Documentation.docc/Contributing/Existentials.md
Outdated
Show resolved
Hide resolved
ahoppen
force-pushed
the
ahoppen/document-spi
branch
from
4407c49 to
4d0d98b
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
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.
Also remove the
Create SwiftSyntax Release.mdbecause it describes how to vendor the parser library and we’re no longer doing that.