Skip to content

Commit bc3f7b6

Browse files
author
james
committed
fix find and replace error
1 parent 9bec9b4 commit bc3f7b6

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

docs/codeql/codeql-cli/about-ql-packs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ files and directories within the pack should be logically organized. For example
2121
- Queries are organized into directories for specific categories.
2222
- Queries for specific products, libraries, and frameworks are organized into
2323
their own top-level directories.
24-
- There is a top-level directory named ``<owner>/<ql-language-specification>`` for query library
24+
- There is a top-level directory named ``<owner>/<language>`` for query library
2525
(``.qll``) files. Within this directory, ``.qll`` files should be organized into
2626
subdirectories for specific categories.
2727

docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The starter workspace is a Git repository. It contains:
8080

8181
* The `repository of CodeQL libraries and queries <https://github.com/github/codeql>`__ for C/C++, C#, Java, JavaScript, and Python. This is included as a submodule, so it can be updated without affecting your custom queries.
8282
* The `repository of CodeQL libraries and queries <https://github.com/github/codeql-go>`__ for Go. This is also included as a submodule.
83-
* A series of folders named ``codeql-custom-queries-<ql-language-specification>``. These are ready for you to start developing your own custom queries for each language, using the standard libraries. There are some example queries to get you started.
83+
* A series of folders named ``codeql-custom-queries-<language>``. These are ready for you to start developing your own custom queries for each language, using the standard libraries. There are some example queries to get you started.
8484

8585
To use the starter workspace:
8686

docs/codeql/writing-codeql-queries/creating-path-queries.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For C/C++, C#, Java, and JavaScript you should use the following template::
5252
* ...
5353
*/
5454

55-
import <ql-language-specification>
55+
import <language>
5656
import DataFlow::PathGraph
5757
...
5858

docs/codeql/writing-codeql-queries/find-the-thief.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ There is too much information to search through by hand, so you decide to use yo
5050

5151
#. Open the `query console on LGTM.com <https://lgtm.com/query>`__ to get started.
5252
#. Select a language and a demo project. For this tutorial, any language and project will do.
53-
#. Delete the default code ``import <ql-language-specification> select "hello world"``.
53+
#. Delete the default code ``import <language> select "hello world"``.
5454

5555
QL libraries
5656
------------

docs/codeql/writing-codeql-queries/introduction-to-ql.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Once you have selected a language, the query console is populated with the query
2323

2424
.. code-block:: ql
2525
26-
import <ql-language-specification>
26+
import <language>
2727
2828
select "hello world"
2929
@@ -124,7 +124,7 @@ The following example queries *do* use these databases and give you an idea of h
124124
Queries using the CodeQL libraries can find errors and uncover variants of important security vulnerabilities in codebases.
125125
Visit `GitHub Security Lab <https://securitylab.github.com/>`__ to read about examples of vulnerabilities that we have recently found in open source projects.
126126

127-
To import the CodeQL library for a specific programming language, type ``import <ql-language-specification>`` at the start of the query.
127+
To import the CodeQL library for a specific programming language, type ``import <language>`` at the start of the query.
128128

129129
.. code-block:: ql
130130

docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The following properties are supported by all query files:
2828
+=======================+===========================+=======================================================================================================================================================================================================================================================================================================================================================================+
2929
| ``@description`` | ``<text>`` | A sentence or short paragraph to describe the purpose of the query and *why* the result is useful or important. The description is written in plain text, and uses single quotes (``'``) to enclose code elements. |
3030
+-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
31-
| ``@id`` | ``<text>`` | A sequence of words composed of lowercase letters or digits, delimited by ``/`` or ``-``, identifying and classifying the query. Each query must have a **unique** ID. To ensure this, it may be helpful to use a fixed structure for each ID. For example, the standard LGTM queries have the following format: ``<ql-language-specification>/<brief-description>``. |
31+
| ``@id`` | ``<text>`` | A sequence of words composed of lowercase letters or digits, delimited by ``/`` or ``-``, identifying and classifying the query. Each query must have a **unique** ID. To ensure this, it may be helpful to use a fixed structure for each ID. For example, the standard LGTM queries have the following format: ``<language>/<brief-description>``. |
3232
+-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
3333
| ``@kind`` | | ``problem`` | Identifies the query is an alert (``@kind problem``) or a path (``@kind path-problem``). For more information on these query types, see ":doc:`About CodeQL queries <about-codeql-queries>`." |
3434
| | | ``path-problem`` | |

0 commit comments

Comments
 (0)