Skip to content

Commit 676d486

Browse files
jf205jbj
andauthored
Apply suggestions from code review
Co-authored-by: Jonas Jensen <[email protected]>
1 parent 5ebaa1d commit 676d486

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/qldoc-style-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
4545

4646
1. Use a third-person verb phrase of the form ``Holds if `arg` has <property>.``.
4747
1. Avoid:
48-
- `/**Whether ...*/`
49-
- `/**"Relates ...*/`
48+
- `/** Whether ... */`
49+
- `/**" Relates ... */`
5050
- Question forms:
51-
- ``/**Is `x` a foo?*/``
52-
- ``/**Does `x` have a bar?*/``
51+
- ``/** Is `x` a foo? */``
52+
- ``/** Does `x` have a bar? */``
5353

5454
#### Example
5555

@@ -64,7 +64,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
6464
### Predicates with result
6565

6666
1. Use a third-person verb phrase of the form `Gets (a|the) <thing>`.
67-
1. Use "if any" if the item is usually unique, but might be missing. For example
67+
1. Use "if any" if the item is usually unique but might be missing. For example
6868
`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
7070
``Holds if `result` is a child of this expression.``.
@@ -113,7 +113,7 @@ Certain special predicates should be documented consistently.
113113
- Always document `toString` as
114114

115115
```ql
116-
/**Gets a textual representation of this element.*/
116+
/** Gets a textual representation of this element. */
117117
string toString() { ... }
118118
```
119119

0 commit comments

Comments
 (0)