Skip to content

Commit 4d755f6

Browse files
authored
docs(style): Add guideline for code block annotations (#2920)
1 parent 4ffd664 commit 4d755f6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

STYLE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,12 @@ Contributors should design their slides with this interactivity in mind. The
161161
initial state of the code should be a good starting point for a live
162162
demonstration.
163163

164+
#### Code Annotations
165+
166+
Use the `ignore` annotation for code snippets that are not meant to be complete,
167+
self-contained programs. Use `compile_fail` only when the goal is to demonstrate
168+
a specific compiler error that is itself the lesson.
169+
164170
### Language and Tone
165171

166172
The courses are written in American English, so write "initialize", not

0 commit comments

Comments
 (0)