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
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
43
43
44
44
### Predicates without result
45
45
46
-
1.Document predicates that do not have using 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>.``.
47
47
1. Avoid:
48
48
-`/**Whether ...*/`
49
49
-`/**"Relates ...*/`
@@ -63,7 +63,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
63
63
64
64
### Predicates with result
65
65
66
-
1.Document predicates that have a result using a third-person verb phrase of the form `Gets (a|the) <thing>`.
66
+
1.Use a third-person verb phrase of the form `Gets (a|the) <thing>`.
67
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
@@ -117,15 +117,15 @@ Certain special predicates should be documented consistently.
117
117
string toString() { ... }
118
118
```
119
119
120
-
- Always document `hasLocationInfo`be documented like this:
120
+
- Always document `hasLocationInfo`as
121
121
122
122
```ql
123
123
/**
124
124
* Holds if this element is at the specified location.
125
125
* The location spans column `startcolumn` of line `startline` to
126
126
* column `endcolumn` of line `endline` in file `filepath`.
0 commit comments