Skip to content

Commit

Permalink
docs: updated section on assertions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nergal-perm committed May 13, 2024
1 parent 545a8c2 commit 19b66e9
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,18 @@ commands:
So, every command should have a name and a description of the request. The request should contain the
description of the data fragments, which are the Coordinates of the system's state.

3. Expectations - the expected result of decision tables computation after all the commands are executed.
The expectations should be described in the following format:
3. Expectations - the expected result of decision tables computation OR state of the entities after
all the commands are executed. The expectations should be described in the following format:

```yaml
game_state:
is_over: "false"
winner: "none"
```

It looks like the description of the initial state, but the upper-level keys are the names of the
decision tables, and the lower-level keys are the names of the outcomes with their expected values.
If it is the assertion on a decision table, then the upper-level key should be the name of the
decision table, and the lower-level keys are the names of the outcomes with their expected values.
If it is the assertion on a state, then it's the same format as in the initial state description.

## Running the tests

Expand Down

0 comments on commit 19b66e9

Please sign in to comment.