From 0b4345bd25d14c2bebfeff60d199ef3540bc6264 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 6 Feb 2024 08:48:30 -0800 Subject: [PATCH] Update code annotation guidelines with info on `#!` (#49041) --- .../writing-for-github-docs/annotating-code-examples.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/contributing/writing-for-github-docs/annotating-code-examples.md b/content/contributing/writing-for-github-docs/annotating-code-examples.md index ffaa521b78cb..b0f88b008097 100644 --- a/content/contributing/writing-for-github-docs/annotating-code-examples.md +++ b/content/contributing/writing-for-github-docs/annotating-code-examples.md @@ -39,6 +39,7 @@ The following rules apply to all code annotations. - You can include any number of spaces before the comment tag starts. - You can include any number of spaces after the comment tag ends. - To create a blank annotation, insert a comment tag with no text after it. Blank annotations are useful if some lines of a sample don't require an annotation. +- Strings that begin with `#!` will render in the code block and are not treated as comments. - Anything after the comment tag will be parsed with Markdown. Links, versioning, and other styling will render as if they were written in Markdown. - Multiple sequential comments will create a single annotation. - Lines that do not start with a comment tag and are empty or only contain spaces will be ignored.