Skip to content

Commit 8d5077a

Browse files
committed
Suggest using target language syntax highlighting in QLDoc
1 parent 843c5c6 commit 8d5077a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/qldoc-style-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
1313
- For single-line documentation, the `/**` and `*/` are written on the same line as the comment.
1414
- For multi-line documentation, the `/**` and `*/` are written on separate lines. There is a `*` preceding each comment line, aligned on the first `*`.
1515
1. Use code formatting (backticks) within comments for code from the source language, and also for QL code (for example, names of classes, predicates, and variables).
16-
1. Give explanatory examples of code in the target language, enclosed in ```` ``` ```` or `` ` ``.
16+
1. Give explanatory examples of code in the target language, enclosed in ```` ```<target language> ```` or `` ` ``.
1717

1818

1919
### Language requirements
@@ -37,7 +37,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
3737

3838
1. Refer to all predicate parameters in the predicate documentation.
3939
1. Reference names, such as types and parameters, using backticks `` ` ``.
40-
1. Give examples of code in the target language, enclosed in ```` ``` ```` or `` ` ``.
40+
1. Give examples of code in the target language, enclosed in ```` ```<target language> ```` or `` ` ``.
4141
1. Predicates that override a single predicate don't need QLDoc, as they will inherit it.
4242

4343
### Predicates without result

0 commit comments

Comments
 (0)