encoding/jsonschema: add docs about test file conventions

This makes it clearer how to write jsonschema test cases.
It was intended to be part of https://cuelang.org/cl/1199743
but was accidentally omitted from that CL.

Signed-off-by: Roger Peppe <[email protected]>
Change-Id: I2e5f92526ace4949551b0976cdf9c3d9313e0502
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1200066
Reviewed-by: Daniel Martí <[email protected]>
TryBot-Result: CUEcueckoo <[email protected]>
Unity-Result: CUE porcuepine <[email protected]>

Author: rogpeppe

encoding/jsonschema/decode_test.go

@@ -45,6 +45,20 @@ import (
 // JSON schema to CUE and compares it against the output.
 //
 // Set CUE_UPDATE=1 to update test files with the corresponding output.
+//
+// Each test extracts the JSON Schema from a schema file (either
+// schema.json or schema.yaml) and writes the result to
+// out/decode/extract.
+//
+// If there are any files in the "test" directory in the txtar, each one
+// is extracted and validated against the extracted schema. If the file
+// name starts with "err-" it is expected to fail, otherwise it is
+// expected to succeed.
+//
+// The #noverify tag in the txtar header causes verification and
+// instance tests to be skipped.
+//
+// The #openapi tag in the txtar header enables OpenAPI extraction mode.
 func TestDecode(t *testing.T) {
 	test := cuetxtar.TxTarTest{
 		Root:   "./testdata",