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

Remove trailing spaces and extra blank lines

Browse Source
This commit is contained in:
Owen Mansel-Chan
2025-06-11 12:03:17 +01:00
parent 75caa182f5
commit c8a5418969
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/query-help-style-guide.md
View File

@@ -16,7 +16,7 @@ When you contribute a new [supported query](supported-queries.md) to this reposi
### Location and file name
Query help files must have the same base name as the query they describe and must be located in the same directory.
Query help files must have the same base name as the query they describe and must be located in the same directory.
### File structure and layout
@@ -42,7 +42,6 @@ Section-level elements are used to group the information within the query help f
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.
## English style
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
>S. R. Chidamber and C. F. Kemerer, _A metrics suite for object-oriented design_. IEEE Transactions on Software Engineering, 20(6):476-493, 1994.
### Websites
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
scope of an <code>if</code> statement, and adding more statements to the body of the <code>if</code>
statement is less error-prone.</p>
<p>You should also ensure that the indentation of the code is consistent with the actual flow of
<p>You should also ensure that the indentation of the code is consistent with the actual flow of
control, so that it does not confuse programmers.</p>
</recommendation>
<example>
<p>In the example below, the original version of <code>Cart</code> is missing braces. This means
<p>In the example below, the original version of <code>Cart</code> is missing braces. This means
that the code triggers a <code>NullPointerException</code> at runtime if <code>i</code>
is <code>null</code>.</p>