Skip to content

Commit c7cfd59

Browse files
jf205shati-patel
andauthored
Apply suggestions from code review
Co-authored-by: Shati Patel <[email protected]>
1 parent 3fa49a9 commit c7cfd59

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/qldoc-style-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
1212
1. Use `/** ... */` for documentation, even for single line comments.
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 `*`.
15-
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).
15+
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).
1616
1. Give explanatory examples of code in the target language, enclosed in ```` ``` ```` or `` ` ``.
1717

1818

@@ -43,7 +43,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
4343

4444
### Predicates without result
4545

46-
1. Use a third-person verb phrase of the form ``Holds if `arg` has <property>.``.
46+
1. Use a third-person verb phrase of the form ``Holds if `arg` has <property>.``
4747
1. Avoid:
4848
- `/** Whether ... */`
4949
- `/**" Relates ... */`
@@ -65,9 +65,9 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
6565

6666
1. Use a third-person verb phrase of the form `Gets (a|the) <thing>`.
6767
1. Use "if any" if the item is usually unique but might be missing. For example
68-
`Gets the body of this method, if any.`.
68+
`Gets the body of this method, if any.`
6969
1. If the predicate has more complex behaviour, for example multiple arguments are conceptually "outputs", it can be described like a predicate without a result. For example
70-
``Holds if `result` is a child of this expression.``.
70+
``Holds if `result` is a child of this expression.``
7171
1. Avoid:
7272
- `Get a ...`
7373
- `The ...`
@@ -96,7 +96,7 @@ deprecated Expr getInitializer()
9696

9797
### Internal predicates
9898

99-
Some predicates are internal-only declarations that cannot be made private. The documentation for internal predicates should begin with `INTERNAL: Do not use.`.
99+
Some predicates are internal-only declarations that cannot be made private. The documentation for internal predicates should begin with `INTERNAL: Do not use.`
100100

101101
#### Example
102102

@@ -170,8 +170,8 @@ Modules should be documented using a third-person verb phrase of the form `Provi
170170
/** Provides logic for determining constant expressions. */
171171
```
172172
```ql
173-
/** Provides classes representing the control flow graph within functions. */
174-
```
173+
/** Provides classes representing the control flow graph within functions. */
174+
```
175175

176176
## Special variables
177177

0 commit comments

Comments
 (0)