hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-29 02:35:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify min, max and rank documentation regarding expression type

Browse Source
This commit is contained in:
Marcono1234
2022-04-16 18:53:07 +02:00
committed by GitHub
parent d094bbc06d
commit 8fdfe5426f
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -227,7 +227,7 @@ 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``.
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,8 +297,8 @@ 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``.
For example, the following aggregation returns the value that is ranked 4th out of all the