Skip to content

Commit 3eea045

Browse files
author
Felicity Chapman
authored
Merge pull request #2180 from shati-patel/docs/renaming
Docs: Update terminology
2 parents ef1778a + bd08e8b commit 3eea045

File tree

70 files changed

+505
-495
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+505
-495
lines changed

docs/language/global-sphinx-files/_templates/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
</div>
6262
<div class="linkcontainer">
6363
<div class="linkbar">
64-
<a href="https://help.semmle.com/QL/learn-ql/" target="_blank">Learn QL</a>
64+
<a href="https://help.semmle.com/QL/learn-ql/" target="_blank">Learn CodeQL</a>
6565
<a href="https://help.semmle.com/QL/learn-ql/ql-training.html" target="_blank">QL for variant analysis</a>
6666
<a href="https://help.semmle.com/QL/ql-tools.html" target="_blank">QL tools</a>
6767
<a href="https://help.semmle.com/QL/ql-explore-queries.html" target="_blank">Queries</a>

docs/language/learn-ql/about-ql.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
About QL
22
========
33

4-
This section is aimed at users with a background in general purpose programming as well as in databases. For a basic introduction and information on how to get started, see :doc:`Introduction to the QL language <introduction-to-ql>` and :doc:`Learning QL <../index>`.
4+
This section is aimed at users with a background in general purpose programming as well as in databases. For a basic introduction and information on how to get started, see :doc:`Introduction to QL <introduction-to-ql>` and :doc:`Learning CodeQL <../index>`.
55

66
QL is a declarative, object-oriented query language that is optimized to enable efficient analysis of hierarchical data structures, in particular, databases representing software artifacts.
77

8-
The queries and metrics used in LGTM are implemented using QL. This ensures that they can be extended or revised easily to keep up with changes in definitions of best coding practice. We continually improve existing queries as we work towards the ultimate goal of 100% precision.
8+
The queries and metrics used in LGTM are implemented using CodeQL, which uses QL to analyze code. This ensures that they can be extended or revised easily to keep up with changes in definitions of best coding practice. We continually improve existing queries as we work towards the ultimate goal of 100% precision.
99

1010
You can write queries to identify security vulnerabilities, find coding errors and bugs, or find code that breaks your team's guidelines for best practice. You can also create customized versions of the default queries to accommodate a new framework.
1111

docs/language/learn-ql/advanced/abstract-classes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Semantics of abstract classes
44
Concrete classes
55
----------------
66

7-
Concrete QL classes, as described in the QL language handbook topic on `Classes <https://help.semmle.com/QL/ql-handbook/types.html#classes>`__, lend themselves well to top-down modeling. We start from general superclasses representing large sets of values, and carve out individual subclasses representing more restricted sets of values.
7+
Concrete classes, as described in the QL language handbook topic on `Classes <https://help.semmle.com/QL/ql-handbook/types.html#classes>`__, lend themselves well to top-down modeling. We start from general superclasses representing large sets of values, and carve out individual subclasses representing more restricted sets of values.
88

99
A classic example where this approach is useful is when modeling ASTs (Abstract Syntax Trees): the node types of an AST form a natural inheritance hierarchy, where, for example, there is a class ``Expr`` representing all expression nodes, with many different subclasses for different categories of expressions. There might be a class ``ArithmeticExpr`` representing arithmetic expressions, which in turn could have subclasses ``AddExpr`` and ``SubExpr``.
1010

@@ -57,7 +57,7 @@ Like a concrete class, an abstract class has one or more superclasses and a char
5757
Example
5858
~~~~~~~
5959

60-
The following example is taken from the standard QL library for Java:
60+
The following example is taken from the CodeQL library for Java:
6161

6262
.. code-block:: ql
6363

docs/language/learn-ql/advanced/advanced-ql.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Advanced QL
88
./*
99

1010

11-
Topics on advanced uses of QL. These topics assume that you are familiar with the QL language and the basics of query writing.
11+
Topics on advanced uses of QL. These topics assume that you are familiar with QL and the basics of query writing.
1212

1313
- :doc:`Semantics of abstract classes <abstract-classes>`
1414
- :doc:`Choosing appropriate ways to constrain types <constraining-types>`

docs/language/learn-ql/advanced/constraining-types.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Type constraint methods
88

99
Note
1010

11-
The examples below use the Java QL library. All QL libraries support using these methods to constrain variables, the only difference is in the names of the classes used.
11+
The examples below use the CodeQL library for Java. All libraries support using these methods to constrain variables, the only difference is in the names of the classes used.
1212

1313
There are several ways of imposing type constraints on variables:
1414

docs/language/learn-ql/advanced/determining-specific-types-variables.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Determining the most specific types of a variable
22
=================================================
33

4-
It is sometimes useful to be able to determine what QL types an entity has -- especially when you are unfamiliar with the QL library used by a query. To help with this, QL provides a predicate called ``getAQlClass()``, which returns the most specific QL types of the entity that it is called on.
4+
It is sometimes useful to be able to determine what types an entity has -- especially when you are unfamiliar with the library used by a query. To help with this, there is a predicate called ``getAQlClass()``, which returns the most specific QL types of the entity that it is called on.
55

66
This can be useful when you are not sure of the most precise class of a value. Discovering a more precise class can allow you to cast to it and use predicates that are not available on the more general class.
77

88
Example
99
-------
1010

11-
If you were working with a Java snapshot database, you might use ``getAQlClass()`` on every ``Expr`` in a callable called ``c``:
11+
If you were working with a Java database, you might use ``getAQlClass()`` on every ``Expr`` in a callable called ``c``:
1212

1313
**Java example**
1414

@@ -23,6 +23,6 @@ If you were working with a Java snapshot database, you might use ``getAQlClass()
2323
and e.getEnclosingCallable() = c
2424
select e, e.getAQlClass()
2525
26-
The result of this query is a list of the most specific types of every ``Expr`` in that function. You will see multiple results for some expressions because that expression is represented by more than one QL type.
26+
The result of this query is a list of the most specific types of every ``Expr`` in that function. You will see multiple results for some expressions because that expression is represented by more than one type.
2727

28-
For example, ``StringLiteral``\ s like ``"Hello"`` in Java belong to both the ``StringLiteral`` QL class (a specialization of the ``Literal`` QL class) and the ``CompileTimeConstantExpr`` QL class. So any instances of ``StringLiteral``\ s in the results will produce more than one result, one for each of the QL classes to which they belong.
28+
For example, ``StringLiteral``\ s like ``"Hello"`` in Java belong to both the ``StringLiteral`` class (a specialization of the ``Literal`` class) and the ``CompileTimeConstantExpr`` class. So any instances of ``StringLiteral``\ s in the results will produce more than one result, one for each of the classes to which they belong.

docs/language/learn-ql/advanced/equivalence.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The two expressions:
66
#. ``a() != b()``
77
#. ``not(a() = b())``
88

9-
look equivalent - so much so that inexperienced (and even experienced) QL programmers have been known to rewrite one as the other. However, they are not equivalent due to the quantifiers involved.
9+
look equivalent - so much so that inexperienced (and even experienced) programmers have been known to rewrite one as the other. However, they are not equivalent due to the quantifiers involved.
1010

1111
Thinking of ``a()`` and ``b()`` as sets of values, the first expression says that there is a pair of values (one from each side of the inequality) which are different.
1212

docs/language/learn-ql/advanced/monotonic-aggregates.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Monotonic aggregates in QL
22
==========================
33

4-
In addition to standard QL aggregates, QL also supports *monotonic* aggregates. These are a slightly different way of computing aggregates which have some advantages, notably the ability to be used recursively, which normal aggregates do not have. You can enable them in a scope by adding the \ ``language[monotonicAggregates]`` pragma on a predicate, class, or module.
4+
In addition to standard aggregates, QL also supports *monotonic* aggregates. These are a slightly different way of computing aggregates which have some advantages, notably the ability to be used recursively, which normal aggregates do not have. You can enable them in a scope by adding the \ ``language[monotonicAggregates]`` pragma on a predicate, class, or module.
55

66
Syntax
77
------

docs/language/learn-ql/beginner/find-thief-3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ What next?
7777

7878
- Help the villagers track down another criminal in the :doc:`next tutorial <fire-1>`.
7979
- Find out more about the concepts you discovered in this tutorial in the `QL language handbook <https://help.semmle.com/QL/ql-handbook/index.html>`__.
80-
- Explore the libraries that help you get data about code in :doc:`Learning QL <../../index>`.
80+
- Explore the libraries that help you get data about code in :doc:`Learning CodeQL <../../index>`.

docs/language/learn-ql/beginner/fire-2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ What next?
4040

4141
- Find out who will be the new ruler of the village in the :doc:`next tutorial <heir>`.
4242
- Learn more about predicates and classes in the `QL language handbook <https://help.semmle.com/QL/ql-handbook/index.html>`__.
43-
- Explore the libraries that help you get data about code in :doc:`Learning QL <../../index>`.
43+
- Explore the libraries that help you get data about code in :doc:`Learning CodeQL <../../index>`.

0 commit comments

Comments
 (0)