Skip to content

Commit 7e7d7e7

Browse files
author
james
committed
docs: further improvements
1 parent c7cfd59 commit 7e7d7e7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/qldoc-style-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
3232
1. Declarations in query files should be documented.
3333
1. Library files (`.qll` files) should be have a documentation comment at the top of the file.
3434
1. Query files, except for tests, must have a QLDoc query documentation comment at the top of the file.
35-
1. Where a class denotes a generic concept with subclasses, list those subclasses.
3635

3736
## QLDoc for predicates
3837

@@ -63,7 +62,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
6362

6463
### Predicates with result
6564

66-
1. Use a third-person verb phrase of the form `Gets (a|the) <thing>`.
65+
1. Use a third-person verb phrase of the form `Gets (a|the) <thing>.`
6766
1. Use "if any" if the item is usually unique but might be missing. For example
6867
`Gets the body of this method, if any.`
6968
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
@@ -79,7 +78,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
7978
/**
8079
* Gets the expression denoting the super class of this class,
8180
* or nothing if this is an interface or a class without an `extends` clause.
82-
*/
81+
*/
8382
```
8483

8584
### Deprecated predicates
@@ -132,9 +131,10 @@ Certain special predicates should be documented consistently.
132131
```
133132
## QLDoc for classes
134133

135-
1. Document classes using a noun phrase of the form `A <domain element> that <has property>`.
134+
1. Document classes using a noun phrase of the form `A <domain element> that <has property>.`
136135
1. Use "that", not "which".
137136
1. Refer to member elements in the singular.
137+
1. Where a class denotes a generic concept with subclasses, list those subclasses.
138138

139139
#### Example
140140

@@ -162,7 +162,7 @@ class Callable extends ...
162162

163163
## QLDoc for modules
164164

165-
Modules should be documented using a third-person verb phrase of the form `Provides <classes and predicates to do something>`.
165+
Modules should be documented using a third-person verb phrase of the form `Provides <classes and predicates to do something>.`
166166

167167
#### Example
168168

0 commit comments

Comments
 (0)