Skip to content

Commit

Permalink
Fix broken links in Contributing.md
Browse files Browse the repository at this point in the history
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 apple/swift-docc#685 (comment)
  • Loading branch information
ahoppen committed Aug 5, 2023
1 parent f4dd574 commit 90e4b36
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ swift run --package-path CodeGeneration generate-swiftsyntax
## Adding and Removing Syntax Nodes

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

@Comment {
When docc resolves https://github.com/apple/swift-docc/issues/255, this should
be an inter-target link.
}

When updating nodes, certain clients of SwiftSyntax that are relying upon those
nodes will need to be changed in tandem. For example, the
[swift-stress-tester][swift-stress-tester] uses SwiftSyntax, and the CI
Expand All @@ -81,3 +76,8 @@ without a paired change to that repository.
[SyntaxSupport]: https://github.com/apple/swift-syntax/tree/main/CodeGeneration/Sources/SyntaxSupport
[swift-stress-tester]: https://github.com/apple/swift-stress-tester
[ParserBasics]: https://github.com/apple/swift-syntax/tree/main/Sources/SwiftParser/SwiftParser.docc/ParsingBasics.md

@Comment {
When docc resolves https://github.com/apple/swift-docc/issues/255, `ParserBasic` should be an inter-target link.
}

0 comments on commit 90e4b36

Please sign in to comment.