Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 203d74f

Browse files
committed
Remove links to QLDoc spec
1 parent 0bd8c55 commit 203d74f

3 files changed

Lines changed: 4 additions & 6 deletions

File tree

docs/codeql/ql-language-reference/about-the-ql-language.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ When you write this process in QL, it closely resembles the above structure. Not
4444
For more information about the important concepts and syntactic constructs of QL, see the individual reference topics such as ":doc:`Expressions <expressions>`" and ":doc:`Recursion <recursion>`."
4545
The explanations and examples help you understand how the language works, and how to write more advanced QL code.
4646

47-
For formal specifications of the QL language and QLDoc comments, see the ":doc:`QL language specification <ql-language-specification>`" and ":doc:`QLDoc comment specification <qldoc-comment-specification>`."
47+
For a formal specification of the QL language, see the ":doc:`QL language specification <ql-language-specification>`."
4848

4949
QL and object orientation
5050
-------------------------

docs/codeql/ql-language-reference/lexical-syntax.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,10 @@ For an overview of the lexical syntax, see "`Lexical syntax
1616
Comments
1717
********
1818

19-
All standard one-line and multiline comments, as described in the "`QL language specification
20-
<ql-language-specification#comments>`_," are ignored by the QL
19+
All standard one-line and multiline comments are ignored by the QL
2120
compiler and are only visible in the source code.
2221
You can also write another kind of comment, namely **QLDoc comments**. These comments describe
23-
QL entities and are displayed as pop-up information in QL editors. For information about QLDoc
24-
comments, see the ":doc:`QLDoc comment specification <qldoc-comment-specification>`."
22+
QL entities and are displayed as pop-up information in QL editors.
2523

2624
The following example uses these three different kinds of comments:
2725

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Metadata tells users important information about CodeQL queries. You must includ
88
About query metadata
99
--------------------
1010

11-
Any query that is run as part of an analysis includes a number of properties, known as query metadata. Metadata is included at the top of each query file as the content of a :ref:`QLDoc <qldoc-comment-specification>` comment.
11+
Any query that is run as part of an analysis includes a number of properties, known as query metadata. Metadata is included at the top of each query file as the content of a QLDoc comment.
1212
This metadata tells LGTM and the CodeQL :ref:`extension for VS Code <codeql-for-visual-studio-code>` how to handle the query and display its results correctly.
1313
It also gives other users information about what the query results mean. For more information on query metadata, see the `query metadata style guide <https://github.com/github/codeql/blob/main/docs/query-metadata-style-guide.md>`__ in our `open source repository <https://github.com/github/codeql>`__ on GitHub.
1414

0 commit comments

Comments
 (0)