Skip to content

Commit

Permalink
address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
scgkiran committed Nov 21, 2024
1 parent e5417f1 commit 2533977
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,21 @@ A test file consists of the following elements:
## Syntax

### Version Declaration
The version declaration must be the first line of the file. It specifies the version of the test file format. The version declaration must be in the following format:
```
The version declaration must appear as the first line of the file. It defines the type of tests in the file and test file format version.
Each test file must exclusively contain either scalar tests or aggregate tests. Mixing test types in the same file is not allowed.
The version declaration should follow this format:
```code
### SUBSTRAIT_SCALAR_TEST: V1
```
or

```code
### SUBSTRAIT_AGGREGATE_TEST: V1
```

### Include Statements
Include statements should have at least one include statement. The include statement specifies the path to substrait extension functions. The include statement must be in the following format:
```
```code
### SUBSTRAIT_INCLUDE: /extensions/functions_aggregate_approx.yaml
```

Expand Down

0 comments on commit 2533977

Please sign in to comment.