diff --git a/services/search/pkg/parity/README.md b/services/search/pkg/parity/README.md index 67c02ab784..fb86424d73 100644 --- a/services/search/pkg/parity/README.md +++ b/services/search/pkg/parity/README.md @@ -1,6 +1,6 @@ # Engine parity -Written by the parity suite (`go test ./services/search/pkg/parity/`), do not edit. +Written by the parity suite (`UPDATE_MATRIX=true go test ./services/search/pkg/parity/`), do not edit. Every case runs against bleve and OpenSearch. `same?` is ✅ when both answer as expected, `❌ known` when an engine's divergence is documented in the case (`engineOverrides`), `❌` when it is not. `✅ stale` when every engine diff --git a/services/search/pkg/parity/matrix_test.go b/services/search/pkg/parity/matrix_test.go index c10fed5e56..6347ae6571 100644 --- a/services/search/pkg/parity/matrix_test.go +++ b/services/search/pkg/parity/matrix_test.go @@ -171,7 +171,7 @@ func writeMatrix(report types.Report) { out := &strings.Builder{} out.WriteString("# Engine parity\n\n") - out.WriteString("Written by the parity suite (`go test ./services/search/pkg/parity/`), do not edit.\n") + out.WriteString("Written by the parity suite (`UPDATE_MATRIX=true go test ./services/search/pkg/parity/`), do not edit.\n") out.WriteString("Every case runs against bleve and OpenSearch. `same?` is ✅ when both answer as\n") out.WriteString("expected, `❌ known` when an engine's divergence is documented in the case\n") out.WriteString("(`engineOverrides`), `❌` when it is not. `✅ stale` when every engine\n")