From 21ad3fd0f6c9f16d0b3c854e895fdad1209e671d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=9B=A7=E5=9B=A7?= Date: Mon, 17 Jun 2024 16:06:29 -0400 Subject: [PATCH] Update testing-framework.md: improve formatting and clarify expected result descriptions (#165) --- .../docs/developer-guide/testing-framework.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/content/docs/developer-guide/testing-framework.md b/src/content/docs/developer-guide/testing-framework.md index 8ede441..5711ef9 100644 --- a/src/content/docs/developer-guide/testing-framework.md +++ b/src/content/docs/developer-guide/testing-framework.md @@ -175,13 +175,13 @@ unless a new `-CASE` is written. There are three ways to specify the expected result: -| Result | Description | -| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `---- error` | The following lines must be the expected error message. | -| `---- error(regex)` | The following lines must be a regex pattern matching the expected error message. | -| `---- ok` | does not require any additional information below the line. | -| `---- hash` | A single line must follow containing the number of values in the query results and the md5 hash value of the query result. | -| `---- [number of expected tuples]` | The following lines must be exactly the query results. | +| Result | Description | +| ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `---- error` | The following lines must be the expected error message. | +| `---- error(regex)` | The following lines must be a regex pattern matching the expected error message. | +| `---- ok` | does not require any additional information below the line. | +| `---- hash` | A single line must follow containing the number of values in the query results and the md5 hash value of the query result. | +| `---- [number of expected tuples]`
`[expected tuple 1]`
`[expected tuple 2]` | The first line after `----` contains the number of tuples and the following lines must exactly match the query results. | :::note[Note] By default, the expected result tuples can be written in any order. The framework will sort the