hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

QL style guide: Small fixes

Browse Source 
- Don't suggest new line after `deprecated`
- Add a missing backtick
This commit is contained in:
shati-semmle
2018-08-23 15:15:47 +01:00
committed by GitHub
parent 3182274ce8
commit 4965377283
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/ql-style-guide.md
View File

@@ -47,7 +47,7 @@ select c, "This call to '$@' is deprecated because " + reason + ".",
- Before each declaration, except for the first declaration in a *body* - Before each declaration, except for the first declaration in a *body*
- Before the `from`-`where`-`select` section in a query file - Before the `from`-`where`-`select` section in a query file
1. *Avoid* two or more adjacent blank lines. 1. *Avoid* two or more adjacent blank lines.
1. There *must* be a new line after the *annotations* `cached`, `deprecated`, `pragma`, `language` and `bindingset`. Other *annotations* do not have a new line. 1. There *must* be a new line after the *annotations* `cached`, `pragma`, `language` and `bindingset`. Other *annotations* do not have a new line.
1. There *should not* be additional blank lines within a predicate. 1. There *should not* be additional blank lines within a predicate.
1. There *may* be a new line: 1. There *may* be a new line:
- Immediately after the `from`, `where` or `select` keywords in a query. - Immediately after the `from`, `where` or `select` keywords in a query.
@@ -409,7 +409,7 @@ deprecated Expr getInitializer()
| *[conjunct](https://help.semmle.com/QL/QLLanguageSpecification.html#conjunctions)* | A formula that is an operand to an `and`. | | *[conjunct](https://help.semmle.com/QL/QLLanguageSpecification.html#conjunctions)* | A formula that is an operand to an `and`. |
| *declaration* | A class, module, predicate, field or newtype. | | *declaration* | A class, module, predicate, field or newtype. |
| *[disjunct](https://help.semmle.com/QL/QLLanguageSpecification.html#disjunctions)* | A formula that is an operand to an `or`. | | *[disjunct](https://help.semmle.com/QL/QLLanguageSpecification.html#disjunctions)* | A formula that is an operand to an `or`. |
| *[formula](https://help.semmle.com/QL/QLLanguageSpecification.html#formulas)* | A logical expression, such as `A = B`, a *call*, a *quantifier*, `and`, `or`, `not`, 'in` or `instanceof`. | | *[formula](https://help.semmle.com/QL/QLLanguageSpecification.html#formulas)* | A logical expression, such as `A = B`, a *call*, a *quantifier*, `and`, `or`, `not`, `in` or `instanceof`. |
| *should/should not/avoid/prefer* | Adhere to this rule wherever possible, where it makes sense. | | *should/should not/avoid/prefer* | Adhere to this rule wherever possible, where it makes sense. |
| *may/can* | This is a reasonable alternative, to be used with discretion. | | *may/can* | This is a reasonable alternative, to be used with discretion. |
| *must/always/do not* | Always adhere to this rule. | | *must/always/do not* | Always adhere to this rule. |