Skip to content

Commit 570e551

Browse files
author
Felicity Chapman
committed
Update style guides for name change
1 parent 02bb142 commit 570e551

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

docs/ql-style-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# QL Style Guide
1+
# CodeQL style guide
22

33
## Introduction
44

5-
This document describes how to format the QL code you contribute to this repository. It covers aspects such as layout, white-space, naming, and documentation. Adhering to consistent standards makes code easier to read and maintain. Of course, these are only guidelines, and can be overridden as the need arises on a case-by-case basis. Where existing code deviates from these guidelines, prefer consistency with the surrounding code.
5+
This document describes how to format the code you contribute to this repository. It covers aspects such as layout, white-space, naming, and documentation. Adhering to consistent standards makes code easier to read and maintain. Of course, these are only guidelines, and can be overridden as the need arises on a case-by-case basis. Where existing code deviates from these guidelines, prefer consistency with the surrounding code.
66
Note, if you use QL for Eclipse, you can auto-format your query in the [QL editor](https://help.semmle.com/ql-for-eclipse/Content/WebHelp/ql-editor.html).
77

88
Words in *italic* are defined in the [Glossary](#glossary).

docs/query-metadata-style-guide.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Query file metadata and alert message style guide
22

3-
43
## Introduction
54

65
This document outlines the structure of Semmle query files. You should adopt this structure when contributing custom queries to this repository, in order to ensure that new queries are consistent with the standard Semmle queries.
@@ -11,13 +10,13 @@ Query files have the extension `.ql`. Each file has two distinct areas:
1110

1211
* Metadata area–displayed at the top of the file, contains the metadata that defines how results for the query are interpreted and gives a brief description of the purpose of the query.
1312
* Query definition–defined using QL. The query includes a select statement, which defines the content and format of the results. For further information about writing QL, see the following topics:
14-
* [Learning QL](https://help.semmle.com/QL/learn-ql/index.html)
13+
* [Learning CodeQL](https://help.semmle.com/QL/learn-ql/index.html)
1514
* [QL language handbook](https://help.semmle.com/QL/ql-handbook/index.html)
1615
* [QL language specification](https://help.semmle.com/QL/ql-spec/language.html)
1716
* [QL style guide](https://github.com/Semmle/ql/blob/master/docs/ql-style-guide.md)
1817

1918

20-
For examples of query files for the languages supported by Semmle, visit the following links:
19+
For examples of query files for the languages supported by CodeQL, visit the following links:
2120

2221
* [C/C++ queries](https://help.semmle.com/wiki/display/CCPPOBJ/)
2322
* [C# queries](https://help.semmle.com/wiki/display/CSHARP/)
@@ -178,4 +177,4 @@ For examples of select clauses and alert messages, see the query source files at
178177
* [JavaScript queries](https://help.semmle.com/wiki/display/JS/)
179178
* [Python queries](https://help.semmle.com/wiki/display/PYTHON/)
180179

181-
For further information on query writing, see [Writing QL queries](https://help.semmle.com/QL/learn-ql/ql/writing-queries/writing-queries.html). For more information on learning QL, see [Learning QL](https://help.semmle.com/QL/learn-ql/index.html).
180+
For further information on query writing, see [Writing CodeQL queries](https://help.semmle.com/QL/learn-ql/ql/writing-queries/writing-queries.html). For more information on learning CodeQL, see [Learning CodeQL](https://help.semmle.com/QL/learn-ql/index.html).

0 commit comments

Comments
 (0)