Skip to content

Commit 8475ea1

Browse files
committed
Consistent doc file naming
1 parent ba45411 commit 8475ea1

27 files changed

+21
-23
lines changed

Documentation/Parsers/colors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ This parser currently doesn't accept any options.
2222
## Templates
2323

2424
* [See here](../templates/colors) for a list of templates bundled with SwiftGen and their documentation.
25-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/Colors.md) to see what data is available after parsing.
25+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/colors.md) to see what data is available after parsing.

Documentation/Parsers/coredata.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ This parser currently doesn't accept any options.
1717
## Templates
1818

1919
* [See here](../templates/coredata) for a list of templates bundled with SwiftGen and their documentation.
20-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/CoreData.md) to see what data is available after parsing.
20+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/coredata.md) to see what data is available after parsing.

Documentation/Parsers/fonts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ This parser currently doesn't accept any options.
1717
## Templates
1818

1919
* [See here](../templates/fonts) for a list of templates bundled with SwiftGen and their documentation.
20-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/Fonts.md) to see what data is available after parsing.
20+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/fonts.md) to see what data is available after parsing.

Documentation/Parsers/ib.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ This parser currently doesn't accept any options.
1717
## Templates
1818

1919
* [See here](../templates/ib) for a list of templates bundled with SwiftGen and their documentation.
20-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/InterfaceBuilder.md) to see what data is available after parsing.
20+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/ib.md) to see what data is available after parsing.

Documentation/Parsers/json.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# YAML (and JSON) parser
1+
# JSON parser
22

33
## Input
44

5-
The YAML parser accepts multiple files or directories (which it'll recursively search). Each file's content will be loaded into the context, but the parser will also generate metadata about the structure of the file.
6-
7-
YAML files can contain multiple documents, which is why each file can contain multiple `documents` in the structure below.
5+
The JSON parser accepts multiple files or directories (which it'll recursively search). Each file's content will be loaded into the context, but the parser will also generate metadata about the structure of the file.
86

97
Note: The JSON, YAML and Plist parsers provide the same context structure, so you can easily switch input formats while keeping the same template.
108

@@ -22,4 +20,4 @@ This parser currently doesn't accept any options.
2220
## Templates
2321

2422
* [See here](../templates/json) for a list of templates bundled with SwiftGen and their documentation.
25-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/Json.md) to see what data is available after parsing.
23+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/json.md) to see what data is available after parsing.

Documentation/Parsers/plist.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ This parser currently doesn't accept any options.
1919
## Templates
2020

2121
* [See here](../templates/plist) for a list of templates bundled with SwiftGen and their documentation.
22-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/Plist.md) to see what data is available after parsing.
22+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/plist.md) to see what data is available after parsing.

Documentation/Parsers/strings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ You can provide a custom filter using the `filter` option, it accepts any valid
4343
## Templates
4444

4545
* [See here](../templates/strings) for a list of templates bundled with SwiftGen and their documentation.
46-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/Strings.md) to see what data is available after parsing.
46+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/strings.md) to see what data is available after parsing.

Documentation/Parsers/xcassets.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ This parser currently doesn't accept any options.
2424
## Templates
2525

2626
* [See here](../templates/xcassets) for a list of templates bundled with SwiftGen and their documentation.
27-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/Assets.md) to see what data is available after parsing.
27+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/xcassets.md) to see what data is available after parsing.

Documentation/Parsers/yaml.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# YAML (and JSON) parser
1+
# YAML parser
22

33
## Input
44

@@ -22,4 +22,4 @@ This parser currently doesn't accept any options.
2222
## Templates
2323

2424
* [See here](../templates/yaml) for a list of templates bundled with SwiftGen and their documentation.
25-
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/Yaml.md) to see what data is available after parsing.
25+
* If you want to write custom templates, make sure to check the [stencil context documentation](../SwiftGenKit%20Contexts/yaml.md) to see what data is available after parsing.

Sources/SwiftGenKit/Stencil/AssetsCatalogContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/Assets.md
11+
// Documentation/SwiftGenKit Contexts/xcassets.md
1212
//
1313

1414
extension AssetsCatalog.Parser {

Sources/SwiftGenKit/Stencil/ColorsContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/Colors.md
11+
// Documentation/SwiftGenKit Contexts/colors.md
1212
//
1313

1414
extension Colors.Parser {

Sources/SwiftGenKit/Stencil/CoreDataContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/CoreData.md
11+
// Documentation/SwiftGenKit Contexts/coredata.md
1212
//
1313

1414
extension CoreData.Parser {

Sources/SwiftGenKit/Stencil/FontsContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/Fonts.md
11+
// Documentation/SwiftGenKit Contexts/fonts.md
1212
//
1313

1414
extension Fonts.Parser {

Sources/SwiftGenKit/Stencil/InterfaceBuilderContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/InterfaceBuilder.md
11+
// Documentation/SwiftGenKit Contexts/ib.md
1212
//
1313

1414
extension InterfaceBuilder.Parser {

Sources/SwiftGenKit/Stencil/JSONContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/Json.md
11+
// Documentation/SwiftGenKit Contexts/json.md
1212
//
1313

1414
extension JSON.Parser {

Sources/SwiftGenKit/Stencil/PlistContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/Plist.md
11+
// Documentation/SwiftGenKit Contexts/plist.md
1212
//
1313

1414
extension Plist.Parser {

Sources/SwiftGenKit/Stencil/StringsContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ private extension String {
1616

1717
//
1818
// See the documentation file for a full description of this context's structure:
19-
// Documentation/SwiftGenKit Contexts/Strings.md
19+
// Documentation/SwiftGenKit Contexts/strings.md
2020
//
2121

2222
extension Strings.Parser {

Sources/SwiftGenKit/Stencil/YamlContext.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
//
1010
// See the documentation file for a full description of this context's structure:
11-
// Documentation/SwiftGenKit Contexts/Yaml.md
11+
// Documentation/SwiftGenKit Contexts/yaml.md
1212
//
1313

1414
extension Yaml.Parser {

0 commit comments

Comments
 (0)