hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8760 from Marcono1234/patch-1

Browse Source 
Clarify `min`, `max` and `rank` documentation
This commit is contained in:
Anders Schack-Mulligen
2022-04-25 12:20:00 +02:00
committed by GitHub
parent bffa8fa7cb 6a48ba955c
commit fd2904d49c
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/codeql/ql-language-reference/expressions.rst
View File

@@ -227,8 +227,9 @@ The following aggregates are available in QL:
- ``min`` and ``max``: These aggregates determine the smallest (``min``) or largest (``max``)
value of ``<expression>`` among the possible assignments to the aggregation variables.
In this case, ``<expression>`` must be of numeric type or of type ``string``.
``<expression>`` must be of numeric type or of type ``string``, or an explicit order must be defined with ``order by``.
When using ``order by``, more than one result may exist in case of ties.
For example, the following aggregation returns the name of the ``.js`` file (or files) with the
largest number of lines, using the number of lines of code to break ties:
@@ -297,9 +298,10 @@ The following aggregates are available in QL:
.. index:: rank
- ``rank``: This aggregate takes the possible values of ``<expression>`` and ranks them.
In this case, ``<expression>`` must be of numeric type or of type ``string``. The aggregation
returns the value that is ranked in the position specified by the **rank expression**.
``<expression>`` must be of numeric type or of type ``string``, or an explicit order must be defined with ``order by``.
The aggregation returns the value that is ranked in the position specified by the **rank expression**.
You must include this rank expression in brackets after the keyword ``rank``.
When using ``order by``, more than one result may exist in case of ties.
For example, the following aggregation returns the value that is ranked 4th out of all the
possible values. In this case, ``8`` is the 4th integer in the range from ``5`` through