mirror of
https://github.com/github/codeql.git
synced 2026-04-30 19:26:02 +02:00
add quotes to several more links
This commit is contained in:
@@ -5,8 +5,8 @@ Lexical syntax
|
||||
|
||||
The QL syntax includes different kinds of keywords, identifiers, and comments.
|
||||
|
||||
For an overview of the lexical syntax, see `Lexical syntax
|
||||
<https://help.semmle.com/QL/ql-spec/language.html#lexical-syntax>`_ in the QL language specification.
|
||||
For an overview of the lexical syntax, see "`Lexical syntax
|
||||
<https://help.semmle.com/QL/ql-spec/language.html#lexical-syntax>`_" in the QL language specification.
|
||||
|
||||
.. index:: comment, QLDoc
|
||||
.. _comments:
|
||||
@@ -14,12 +14,12 @@ For an overview of the lexical syntax, see `Lexical syntax
|
||||
Comments
|
||||
********
|
||||
|
||||
All standard one-line and multiline comments, as described in the `QL language specification
|
||||
<https://help.semmle.com/QL/ql-spec/language.html#comments>`_, are ignored by the QL
|
||||
All standard one-line and multiline comments, as described in the "`QL language specification
|
||||
<https://help.semmle.com/QL/ql-spec/language.html#comments>`_," are ignored by the QL
|
||||
compiler and are only visible in the source code.
|
||||
You can also write another kind of comment, namely **QLDoc comments**. These comments describe
|
||||
QL entities and are displayed as pop-up information in QL editors. For information about QLDoc
|
||||
comments, see the `QLDoc comment specification <https://help.semmle.com/QL/ql-spec/qldoc.html>`_.
|
||||
comments, see the "`QLDoc comment specification <https://help.semmle.com/QL/ql-spec/qldoc.html>`_."
|
||||
|
||||
The following example uses these three different kinds of comments::
|
||||
|
||||
|
||||
@@ -110,7 +110,7 @@ You can also define a module within another module. This is an explicit module d
|
||||
|
||||
An explicit module is defined with the keyword ``module`` followed by
|
||||
the module name, and then the module body enclosed in braces. It can contain any
|
||||
of the elements listed in :ref:`module-bodies` below, apart from select clauses.
|
||||
of the elements listed in ":ref:`module-bodies`" below, apart from select clauses.
|
||||
|
||||
For example, you could add the following QL snippet to the library file **OneTwoThreeLib.qll**
|
||||
defined :ref:`above <library-modules>`::
|
||||
|
||||
@@ -31,8 +31,7 @@ while ``hasCapital`` is the set of two-tuples ``{("Belgium","Brussels"),("German
|
||||
The `arity <https://en.wikipedia.org/wiki/Arity>`_ of these predicates is one and two, respectively.
|
||||
|
||||
In general, all tuples in a predicate have the same number of elements. The **arity** of
|
||||
a predicate is that number of elements, not including a possible ``result`` variable (see
|
||||
:ref:`predicates-with-result`).
|
||||
a predicate is that number of elements, not including a possible ``result`` variable. For more information, see ":ref:`predicates-with-result`."
|
||||
|
||||
There are a number of `built-in predicates <https://help.semmle.com/QL/ql-spec/language.html#built-ins>`_
|
||||
in QL. You can use these in any queries without needing to :ref:`import <importing-modules>`
|
||||
@@ -147,7 +146,7 @@ predicate recursively, as shown below::
|
||||
|
||||
Now ``getANeighbor("Belgium")`` also returns results, namely ``"France"`` and ``"Germany"``.
|
||||
|
||||
For a more general discussion of recursive predicates and queries, see :ref:`recursion`.
|
||||
For a more general discussion of recursive predicates and queries, see ":ref:`recursion`."
|
||||
|
||||
Kinds of predicates
|
||||
*******************
|
||||
|
||||
@@ -29,7 +29,7 @@ file) of the following form::
|
||||
|
||||
The ``from`` and ``where`` parts are optional.
|
||||
|
||||
Apart from the expressions described in :ref:`expressions`, you can also include:
|
||||
Apart from the expressions described in ":ref:`expressions`," you can also include:
|
||||
- The ``as`` keyword, followed by a name. This gives a "label" to a column of results, and allows
|
||||
you to use them in subsequent select expressions.
|
||||
- The ``order by`` keywords, followed by the name of a result column, and optionally the
|
||||
|
||||
Reference in New Issue
Block a user