Skip to content

Commit 1da9919

Browse files
committed
revising note about snippets vs. docc catalogs and target linkage
1 parent ced4877 commit 1da9919

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

Sources/SwiftDocC/Semantics/Snippets/Snippet.swift

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ import Foundation
1212
public import Markdown
1313
import SymbolKit
1414

15-
// NOTE: If you update the DocC content, remember to run
16-
// `swift run generate-symbol-graph` to regenerate the DocC
17-
// symbol content for the DocC Documentation.
18-
1915
/// Embeds a code example from the project's code snippets.
2016
///
2117
/// ```markdown

Sources/docc/DocCDocumentation.docc/adding-code-snippets-to-your-content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ YourProject
6262
etc...
6363
```
6464

65-
> Note: Unlike `Snippets`, your Swift package's documentation catalog should be located as a subdirectory of `Sources`, where all of your other Swift source code files are located. For example, see `YourProject.docc` above.
66-
65+
> Note: Snippets are a package-wide resource, and package manager compiles each snippet into its own module.
66+
> As such, the `Snippets` directory is separate from documentation catalogs, located with each target's source files.
6767
6868
The following example illustrates a code example in the file `Snippets/example-snippet.swift`:
6969

0 commit comments

Comments
 (0)