Skip to content

Commit 90e4b36

Browse files
committed
Fix broken links in Contributing.md
Fixing two issues: - `SyntaxSupport` should use the `[][]` style link because the link is defined at the bottom of the page. - We need to move the `@Comment` to the end of the page to avoid hitting swiftlang/swift-docc#685 (comment)
1 parent f4dd574 commit 90e4b36

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Sources/SwiftSyntax/Documentation.docc/Contributing/ChangingSwiftSyntax.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ swift run --package-path CodeGeneration generate-swiftsyntax
2222
## Adding and Removing Syntax Nodes
2323

2424
The files containing the definition of all of the syntax nodes are available
25-
under the [SyntaxSupport](SyntaxSupport) directory. These files
25+
under the [SyntaxSupport][SyntaxSupport] directory. These files
2626
are roughly divided according to broad syntactic categories in the Swift
2727
programming language. That is, the syntax nodes for classes, structs, and actors
2828
are defined in `DeclNodes.swift`, while the syntax nodes for string literals,
@@ -67,11 +67,6 @@ Added syntactic elements will require corresponding changes to the included
6767
SwiftParser library. For an introduction on parsing Swift nodes, see
6868
[the article on Parsing Basics][ParserBasics].
6969

70-
@Comment {
71-
When docc resolves https://github.com/apple/swift-docc/issues/255, this should
72-
be an inter-target link.
73-
}
74-
7570
When updating nodes, certain clients of SwiftSyntax that are relying upon those
7671
nodes will need to be changed in tandem. For example, the
7772
[swift-stress-tester][swift-stress-tester] uses SwiftSyntax, and the CI
@@ -81,3 +76,8 @@ without a paired change to that repository.
8176
[SyntaxSupport]: https://github.com/apple/swift-syntax/tree/main/CodeGeneration/Sources/SyntaxSupport
8277
[swift-stress-tester]: https://github.com/apple/swift-stress-tester
8378
[ParserBasics]: https://github.com/apple/swift-syntax/tree/main/Sources/SwiftParser/SwiftParser.docc/ParsingBasics.md
79+
80+
@Comment {
81+
When docc resolves https://github.com/apple/swift-docc/issues/255, `ParserBasic` should be an inter-target link.
82+
}
83+

0 commit comments

Comments
 (0)