Add a glossary to SwiftSyntax #1824
Merged
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 |
|
Great initiative. In my exposure to SwiftSyntax, I’ve encountered a few terms that come to mind that were initially unclear to me, or meant something slightly different than what I first assumed. Here are some that come to mind in case you’re looking for inspiration for what could be included in this glossary:
|
bnbarham
approved these changes
Jun 22, 2023
| @@ -0,0 +1,13 @@ | |||
| # Glossary | |||
|
|
|||
| Abbreviations used in SwiftSyntax | |||
There was a problem hiding this comment.
Suggested change
| Abbreviations used in SwiftSyntax | |
| Glossary of terms and abbreviations used in SwiftSyntax |
|
|
||
| To avoid ongoing repetition of common long terms, SwiftSyntax uses a couple of abbreviations that are common in compiler projects. | ||
|
|
||
| **Decl** Abbrevation for *Declaration* |
There was a problem hiding this comment.
Suggested change
| **Decl** Abbrevation for *Declaration* | |
| **Decl** Abbreviation for *Declaration* |
|
|
||
| **Decl** Abbrevation for *Declaration* | ||
|
|
||
| **Expr** Abbrevation for *Expression* |
There was a problem hiding this comment.
Suggested change
| **Expr** Abbrevation for *Expression* | |
| **Expr** Abbreviation for *Expression* |
kimdv
approved these changes
Jun 22, 2023
ahoppen
force-pushed
the
ahoppen/glosssary
branch
from
915fcad to
bb3f90c
Compare
|
Thanks for the suggestions @jpsim. I added some more entries to the glossary. |
|
@swift-ci Please test |
Thanks, these are really helpful. |
bnbarham
reviewed
Jun 22, 2023
The glossary doesn’t contain much yet but I feel it’s always good to have such a document because it will make it easy to add additional entries to it as they come up. rdar://110733511
ahoppen
force-pushed
the
ahoppen/glosssary
branch
from
bb3f90c to
2c7bac3
Compare
|
@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.
The glossary doesn’t contain much yet but I feel it’s always good to have such a document because it will make it easy to add additional entries to it as they come up.
rdar://110733511