Skip to content

Commit

Permalink
Update code annotation guidelines with info on #! (#49041)
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanpalm authored Feb 6, 2024
1 parent b42bf6a commit 0b4345b
Showing 1 changed file with 1 addition and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 0b4345b

Please sign in to comment.