Skip to content

Commit 4274243

Browse files
committed
fixing wording
1 parent 63f8891 commit 4274243

1 file changed

Lines changed: 35 additions & 34 deletions

File tree

Sources/SyntaxKit/Documentation.docc/Documentation.md

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# ``SyntaxKit``
22

3-
SyntaxKit is a Swift package that allows developers to build Swift code using result builders. It provides a declarative way to generate Swift code structures using SwiftSyntax.
3+
SyntaxKit provides a declarative way to generate Swift code structures using SwiftSyntax.
44

55
## Overview
66

7-
SyntaxKit provides a set of result builders that allow you to create Swift code structures in a declarative way. Here's an example:
7+
SyntaxKit allows developers to build Swift code using result builders which enable the creation of Swift code structures in a declarative way. Here's an example:
88

99
```swift
1010
import SyntaxKit
@@ -37,37 +37,6 @@ struct BlackjackCard {
3737
}
3838
```
3939

40-
## Topics
41-
42-
### Declarations
43-
44-
- ``Struct``
45-
- ``Enum``
46-
- ``EnumCase``
47-
- ``Function``
48-
- ``Init``
49-
- ``ComputedProperty``
50-
- ``VariableDecl``
51-
- ``Let``
52-
- ``Variable``
53-
54-
### Expressions & Statements
55-
- ``Assignment``
56-
- ``PlusAssign``
57-
- ``Return``
58-
- ``VariableExp``
59-
60-
### Control Flow
61-
- ``If``
62-
- ``Switch``
63-
- ``SwitchCase``
64-
- ``Default``
65-
66-
### Building Blocks
67-
- ``CodeBlock``
68-
- ``Parameter``
69-
- ``Literal``
70-
7140
## Full Example
7241

7342
Here is a more comprehensive example that demonstrates many of SyntaxKit's features to generate a `BlackjackCard` struct.
@@ -214,4 +183,36 @@ struct BlackjackCard {
214183
return output
215184
}
216185
}
217-
```
186+
```
187+
188+
## Topics
189+
190+
### Declarations
191+
192+
- ``Struct``
193+
- ``Enum``
194+
- ``EnumCase``
195+
- ``Function``
196+
- ``Init``
197+
- ``ComputedProperty``
198+
- ``VariableDecl``
199+
- ``Let``
200+
- ``Variable``
201+
202+
### Expressions & Statements
203+
- ``Assignment``
204+
- ``PlusAssign``
205+
- ``Return``
206+
- ``VariableExp``
207+
208+
### Control Flow
209+
- ``If``
210+
- ``Switch``
211+
- ``SwitchCase``
212+
- ``Default``
213+
214+
### Building Blocks
215+
- ``CodeBlock``
216+
- ``Parameter``
217+
- ``Literal``
218+

0 commit comments

Comments
 (0)