rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-11-29 16:57:35 +02:00
Code Issues Releases Activity

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

Browse Source
This commit is contained in:
Dmitri Gribenko
2025-09-22 11:25:16 +02:00
committed by GitHub
parent 4ffd664f47
commit 4d755f67cc
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
STYLE.md
View File

@@ -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