jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update code-annotations.md

Browse Source
This commit is contained in:
Kevin Heis
2023-06-23 10:00:04 -07:00
committed by GitHub
parent 1e790f7480
commit e61c75ff62
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contributing/code-annotations.md
View File

@@ -17,7 +17,7 @@ For more experienced users, code annotations can help them understand a code exa
An annotated code example must start with a single line annotation. You can start with a blank annotation if you do not want to add an annotation to the first line of code. An annotated code example must start with a single line annotation. You can start with a blank annotation if you do not want to add an annotation to the first line of code.
You must use the comment tag for the language that the code sample is written in. For example, `#` for YAML and `//` for Ruby. You must use the comment tag for the language that the code sample is written in. For example, `#` for YAML and `//` for JavaScript.
To enable code sample annotations, you must specify a language followed by the word `annotate` after the starting triple backtick code tag. To enable code sample annotations, you must specify a language followed by the word `annotate` after the starting triple backtick code tag.