BigInt Documentation #17556
Open
BigInt Documentation #17556
+133
−104
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d10c
force-pushed
the
d10c/bigint-docs
branch
from
25543f3
to
c303137
Compare
d10c
force-pushed
the
d10c/bigint-docs
branch
from
c303137
to
2b06dfc
Compare
jbj
reviewed
Sep 27, 2024
| string provenance | ||
| ); | ||
|
|
||
| An extensible predicate is a CodeQL predicate with the following restrictions: | ||
|
|
||
| - It uses the ``extensible`` keyword. | ||
| - It has no body. | ||
| - All predicate parameters have primitive types. | ||
| - All predicate parameters have type `string`, `int`, `float`, `boolean`, or `date`. |
There was a problem hiding this comment.
Suggested change
| - All predicate parameters have type `string`, `int`, `float`, `boolean`, or `date`. | |
| - All predicate parameters have type ``string``, ``int``, ``float``, ``boolean``, or ``date``. |
|
|
||
| The other built-in operations are: | ||
|
|
||
| * comparisons between :code:`BigInt`s: :code:`=`, :code:`!=`, :code:`<`, :code:`<=`, :code:`>`, :code:`>=`, |
There was a problem hiding this comment.
GitHub's built-in RST renderer gets the quoting wrong in :code:`BigInt`s. I don't know if you'll see the same in our rendered documentation. I'm sure there's a way to preview it, but I don't know how.
| This type is not available in the CodeQL CLI by default, but you can enable it by passing the ``--allow-experimental=bigint`` | ||
| option to the CodeQL CLI. Consequently, queries are currently restricted from returning BigInts as results. | ||
|
|
||
| Unlike :code:`int` and :code:`float`, there is no automatic conversion between :code:`BigInt` and other numeric types. |
There was a problem hiding this comment.
Why use :code: here but double backticks above?
| * bitwise operations: :code:`.bitAnd(BigInt)`, :code:`.bitOr(BigInt)`, | ||
| :code:`.bitXor(BigInt)`, :code:`.bitShiftLeft(int)`, :code:`.bitShiftRightSigned(int)`, | ||
| :code:`.bitNot()`, | ||
| * aggregates: :code:`min`, :code:`max`, (:code:`strict`):code:`sum`, (:code:`strict`):code:`count`, :code:`avg`, |
There was a problem hiding this comment.
The rendering is also wrong around the (:code:`strict`) notation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces public-facing documentation around the experimental
QlBuiltins::BigInttype.Commits
Questions