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/query-help-style-guide.md
+3-5Lines changed: 3 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ When you contribute a new [supported query](supported-queries.md) to this reposi
16
16
17
17
### Location and file name
18
18
19
-
Query help files must have the same base name as the query they describe and must be located in the same directory.
19
+
Query help files must have the same base name as the query they describe and must be located in the same directory.
20
20
21
21
### File structure and layout
22
22
@@ -42,7 +42,6 @@ Section-level elements are used to group the information within the query help f
42
42
43
43
For further information about the other section-level, block, list and table elements supported by query help files, see [Query help files](https://codeql.github.com/docs/writing-codeql-queries/query-help-files/) on codeql.github.com.
44
44
45
-
46
45
## English style
47
46
48
47
You should write the overview and recommendation elements in simple English that is easy to follow. You should:
@@ -98,7 +97,6 @@ If you are citing an academic paper, we recommend adopting the reference style o
98
97
99
98
>S. R. Chidamber and C. F. Kemerer, _A metrics suite for object-oriented design_. IEEE Transactions on Software Engineering, 20(6):476-493, 1994.
100
99
101
-
102
100
### Websites
103
101
104
102
If you are citing a website, please use the following format, without breadcrumb trails:
@@ -154,13 +152,13 @@ later. For example, it's easy to see at a glance which part of the code is in th
154
152
scope of an <code>if</code> statement, and adding more statements to the body of the <code>if</code>
155
153
statement is less error-prone.</p>
156
154
157
-
<p>You should also ensure that the indentation of the code is consistent with the actual flow of
155
+
<p>You should also ensure that the indentation of the code is consistent with the actual flow of
158
156
control, so that it does not confuse programmers.</p>
159
157
160
158
</recommendation>
161
159
<example>
162
160
163
-
<p>In the example below, the original version of <code>Cart</code> is missing braces. This means
161
+
<p>In the example below, the original version of <code>Cart</code> is missing braces. This means
164
162
that the code triggers a <code>NullPointerException</code> at runtime if <code>i</code>
0 commit comments