You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/qldoc-style-guide.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,11 +45,11 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
45
45
46
46
1. Use a third-person verb phrase of the form ``Holds if `arg` has <property>.``.
47
47
1. Avoid:
48
-
-`/**Whether ...*/`
49
-
-`/**"Relates ...*/`
48
+
-`/**Whether ...*/`
49
+
-`/**"Relates ...*/`
50
50
- Question forms:
51
-
-``/**Is `x` a foo?*/``
52
-
-``/**Does `x` have a bar?*/``
51
+
-``/**Is `x` a foo?*/``
52
+
-``/**Does `x` have a bar?*/``
53
53
54
54
#### Example
55
55
@@ -64,7 +64,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
64
64
### Predicates with result
65
65
66
66
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
68
68
`Gets the body of this method, if any.`.
69
69
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
70
``Holds if `result` is a child of this expression.``.
@@ -113,7 +113,7 @@ Certain special predicates should be documented consistently.
113
113
- Always document `toString` as
114
114
115
115
```ql
116
-
/**Gets a textual representation of this element.*/
116
+
/**Gets a textual representation of this element.*/
0 commit comments