Skip to content

docs(style): Add guideline for code block annotations #2920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2025
Merged

docs(style): Add guideline for code block annotations #2920

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,12 @@ Contributors should design their slides with this interactivity in mind. The
initial state of the code should be a good starting point for a live
demonstration.

#### Code Annotations

Use the `ignore` annotation for code snippets that are not meant to be complete,
self-contained programs. Use `compile_fail` only when the goal is to demonstrate
a specific compiler error that is itself the lesson.

### Language and Tone

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