Skip to content

Commit 9827d8b

Browse files
committed
updating with an overview
1 parent a301c22 commit 9827d8b

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

Sources/docc/DocCDocumentation.docc/snippets.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,12 @@ Create and include code snippets to illustrate and provide examples of how to us
44

55
## Overview
66

7-
...tbd...
8-
- Describe the problem and summarize the developer action.
9-
- Explain why the problem is relevant and provide context for the task. Don't simply repeat the abstract; expand on it.
10-
- Keep the Overview to one or two paragraphs.
11-
- For very short articles that consist of just a couple of paragraphs, all of the content can be in the Overview.
7+
DocC supports code listings in your code, as described in <doc:formatting-your-documentation-content>.
8+
However, the content in a code listing isn't compiled or verified to work.
129

13-
...tbd...
10+
Swift Package Manager looks for, and builds, any code included in the `Snippets` directory for your package.
11+
DocC supports referencing all, or parts, of those files to present as code listings.
12+
This allows you to verify that code examples, referenced in your documentation, continue to compile as you evolve you app or library.
1413

1514
### Create a code snippet
1615

0 commit comments

Comments
 (0)