Skip to content

Commit f884473

Browse files
committed
be more explicit about annotation caveats
1 parent 10a02d6 commit f884473

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -738,11 +738,11 @@ The following table summarizes the syntactic constructs which can be marked with
738738
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
739739
| ``extensible`` | | | | yes | | | | | |
740740
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
741-
| ``final`` | yes | | yes | | | yes | | yes | |
741+
| ``final`` | yes | | yes | | | yes | | (yes) | |
742742
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
743743
| ``transient`` | | | | yes | | | | | |
744744
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
745-
| ``library`` | yes | | | | | | | | |
745+
| ``library`` | (yes) | | | | | | | | |
746746
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
747747
| ``private`` | yes | | yes | yes | yes | yes | yes | yes | yes |
748748
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
@@ -756,6 +756,7 @@ The following table summarizes the syntactic constructs which can be marked with
756756
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
757757

758758
The ``library`` annotation is only usable within a QLL file, not a QL file.
759+
The ``final`` annotation is usable on type aliases, but not on module aliases and predicate aliases.
759760

760761
Annotations on aliases apply to the name introduced by the alias. An alias may, for example, have different privacy to the name it aliases.
761762

@@ -808,9 +809,11 @@ A predicate may have several different binding sets, which can be stated by usin
808809
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
809810
| Pragma | Classes | Characters | Member predicates | Non-member predicates | Imports | Fields | Modules | Aliases | Signatures |
810811
+================+=========+============+===================+=======================+=========+========+=========+=========+============+
811-
| ``bindingset`` | | yes | yes | yes | | | | | yes |
812+
| ``bindingset`` | | yes | yes | yes | | | | | (yes) |
812813
+----------------+---------+------------+-------------------+-----------------------+---------+--------+---------+---------+------------+
813814

815+
The ``bindingset`` pragma is usable with type signatures and predicate signatures, but not with module signatures.
816+
814817
QLDoc
815818
-----
816819

0 commit comments

Comments
 (0)