Skip to content

Commit 8160ef6

Browse files
committed
update annotation docs to reference signatures
1 parent 1408c24 commit 8160ef6

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

docs/codeql/ql-language-reference/annotations.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ body must also be annotated with ``cached``, otherwise a compiler error is repor
126126
``deprecated``
127127
==============
128128

129-
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|
129+
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|, |signatures|
130130

131131
The ``deprecated`` annotation is applied to names that are outdated and scheduled for removal
132132
in a future release of QL.
@@ -235,7 +235,7 @@ warning.
235235
``private``
236236
===========
237237

238-
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|
238+
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|, |signatures|
239239

240240
The ``private`` annotation is used to prevent names from being exported.
241241

@@ -461,7 +461,7 @@ For more information, see ":ref:`monotonic-aggregates`."
461461
Binding sets
462462
============
463463

464-
**Available for**: |classes|, |characteristic predicates|, |member predicates|, |non-member predicates|
464+
**Available for**: |classes|, |characteristic predicates|, |member predicates|, |non-member predicates|, |predicate signatures|, |type signatures|
465465

466466
``bindingset[...]``
467467
-------------------
@@ -491,3 +491,6 @@ The ``bindingset`` annotation takes a comma-separated list of variables.
491491
.. |type-aliases| replace:: :ref:`type aliases <type-aliases>`
492492
.. |algebraic datatypes| replace:: :ref:`algebraic datatypes <algebraic-datatypes>`
493493
.. |expressions| replace:: :ref:`expressions <expressions>`
494+
.. |signatures| replace:: :ref:`signatures <signatures>`
495+
.. |predicate signatures| replace:: :ref:`predicate signatures <predicate-signatures>`
496+
.. |type signatures| replace:: :ref:`type signatures <type-signatures>`

docs/codeql/ql-language-reference/signatures.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Signatures
1010
Parameterized modules use signatures as a type system for their parameters.
1111
There are three categories of signatures: **predicate signatures**, **type signatures**, and **module signatures**.
1212

13+
.. index:: predicate signature
14+
15+
.. _predicate-signatures:
16+
1317
Predicate signatures
1418
====================
1519

@@ -36,6 +40,10 @@ For example:
3640
3741
signature int operator(int lhs, int rhs);
3842
43+
.. index:: type signature
44+
45+
.. _type-signatures:
46+
3947
Type signatures
4048
===============
4149

@@ -66,6 +74,10 @@ For example:
6674
string toString();
6775
}
6876
77+
.. index:: module signature
78+
79+
.. _module-signatures:
80+
6981
Module signatures
7082
=================
7183

0 commit comments

Comments
 (0)