Skip to content

Commit 9f90e2d

Browse files
committed
Updates based on feedback from Juan
1 parent 3426e76 commit 9f90e2d

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

annotations/README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,15 @@ A short description of what behavior the Test Case is covering.
2828

2929
The `compatibility` option allows you to set which dialects the Test Case is
3030
compatible with. Test Runners can use this value to filter out Test Cases that
31-
don't apply the to dialect currently under test. Dialects are indicated by the
32-
number corresponding to their release. Date-based releases use just the year.
31+
don't apply the to dialect currently under test. The concept of annotations
32+
didn't appear in the spec until 2019-09, but the concept is compatible with
33+
older releases as well. When setting `compatibility`, test authors should take
34+
into account dialects before 2019-09 for implementations that chose to support
35+
annotations for older dialects.
3336

34-
If this option isn't present, it means the Test Case is compatible with any
35-
dialect.
37+
Dialects are indicated by the number corresponding to their release. Date-based
38+
releases use just the year. If this option isn't present, it means the Test Case
39+
is compatible with any dialect.
3640

3741
If this option is present with a number, the number indicates the minimum
3842
release the Test Case is compatible with. This example indicates that the Test
@@ -102,8 +106,11 @@ The annotating keyword.
102106

103107
An array of `keyword` annotations expected on the instance at `location`.
104108
`expected` is an array because there's always a chance that an annotation is
105-
applied multiple times to any given instance location. Test runners can consider
106-
this an unordered list, but as a convention for this Test Suite, the `expected`
107-
array should be sorted such that the most recently encountered value for an
108-
annotation given top-down evaluation of the schema comes before previously
109-
encountered values.
109+
applied multiple times to any given instance location. An empty array is an
110+
assertion that the annotation must not appear at the `location` for the
111+
`keyword`.
112+
113+
Test runners can consider this an unordered list, but as a convention for this
114+
Test Suite, the `expected` array should be sorted such that the most recently
115+
encountered value for an annotation given top-down evaluation of the schema
116+
comes before previously encountered values.

0 commit comments

Comments
 (0)