Skip to content

Commit 7893768

Browse files
committed
update annotation docs to reference type unions
1 parent 8160ef6 commit 7893768

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ own body, or they must inherit from another class that overrides ``isSource``:
103103
``cached``
104104
==========
105105

106-
**Available for**: |classes|, |algebraic datatypes|, |characteristic predicates|, |member predicates|, |non-member predicates|, |modules|
106+
**Available for**: |classes|, |algebraic datatypes|, |type unions|, |characteristic predicates|, |member predicates|, |non-member predicates|, |modules|
107107

108108
The ``cached`` annotation indicates that an entity should be evaluated in its entirety and
109109
stored in the evaluation cache. All later references to this entity will use the
@@ -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|, |signatures|
129+
**Available for**: |classes|, |algebraic datatypes|, |type unions|, |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|, |signatures|
238+
**Available for**: |classes|, |algebraic datatypes|, |type unions|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|, |signatures|
239239

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

@@ -490,6 +490,7 @@ The ``bindingset`` annotation takes a comma-separated list of variables.
490490
.. |aliases| replace:: :ref:`aliases <aliases>`
491491
.. |type-aliases| replace:: :ref:`type aliases <type-aliases>`
492492
.. |algebraic datatypes| replace:: :ref:`algebraic datatypes <algebraic-datatypes>`
493+
.. |type unions| replace:: :ref:`type unions <type-unions>`
493494
.. |expressions| replace:: :ref:`expressions <expressions>`
494495
.. |signatures| replace:: :ref:`signatures <signatures>`
495496
.. |predicate signatures| replace:: :ref:`predicate signatures <predicate-signatures>`

0 commit comments

Comments
 (0)