Skip to content

Commit 5ebaa1d

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

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/ql-style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ class Type extends ... {
214214

215215
## Documentation
216216

217-
For more information about documenting the code that you contribute to this repository, see the [QLDoc style guide](ql-doc-style-guide.md).
217+
For more information about documenting the code that you contribute to this repository, see the [QLDoc style guide](qldoc-style-guide.md).
218218

219219
## Formulas
220220
1. *Prefer* one *conjunct* per line.

docs/qldoc-style-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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. 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>.``.
4747
1. Avoid:
4848
- `/**Whether ...*/`
4949
- `/**"Relates ...*/`
@@ -63,7 +63,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
6363

6464
### Predicates with result
6565

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>`.
6767
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
@@ -117,15 +117,15 @@ Certain special predicates should be documented consistently.
117117
string toString() { ... }
118118
```
119119

120-
- Always document `hasLocationInfo` be documented like this:
120+
- Always document `hasLocationInfo` as
121121

122122
```ql
123123
/**
124124
* Holds if this element is at the specified location.
125125
* The location spans column `startcolumn` of line `startline` to
126126
* column `endcolumn` of line `endline` in file `filepath`.
127127
* For more information, see
128-
* [Locations](https://help.semmle.com/QL/learn-ql/ql/locations.html).
128+
* [Locations](https://help.semmle.com/QL/learn-ql/locations.html).
129129
*/
130130
131131
predicate hasLocationInfo(string filepath, int startline, int startcolumn, int endline, int endcolumn) { ... }

0 commit comments

Comments
 (0)