From 8d5077ae83b039e84413d587b53ac791bd756ffa Mon Sep 17 00:00:00 2001 From: Tom Hvitved Date: Tue, 23 Jun 2020 14:48:04 +0200 Subject: [PATCH] Suggest using target language syntax highlighting in QLDoc --- docs/qldoc-style-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/qldoc-style-guide.md b/docs/qldoc-style-guide.md index 9ed8ee956b0..79871ae8d9f 100644 --- a/docs/qldoc-style-guide.md +++ b/docs/qldoc-style-guide.md @@ -13,7 +13,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st - For single-line documentation, the `/**` and `*/` are written on the same line as the comment. - For multi-line documentation, the `/**` and `*/` are written on separate lines. There is a `*` preceding each comment line, aligned on the first `*`. 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). -1. Give explanatory examples of code in the target language, enclosed in ```` ``` ```` or `` ` ``. +1. Give explanatory examples of code in the target language, enclosed in ```` ``` ```` or `` ` ``. ### Language requirements @@ -37,7 +37,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st 1. Refer to all predicate parameters in the predicate documentation. 1. Reference names, such as types and parameters, using backticks `` ` ``. -1. Give examples of code in the target language, enclosed in ```` ``` ```` or `` ` ``. +1. Give examples of code in the target language, enclosed in ```` ``` ```` or `` ` ``. 1. Predicates that override a single predicate don't need QLDoc, as they will inherit it. ### Predicates without result