Skip to content

Commit

Permalink
fixup! fixup! fixup! Add docs on project structure and modular design
Browse files Browse the repository at this point in the history
  • Loading branch information
soxofaan committed Jan 25, 2024
1 parent 5340dd9 commit 8b3faa4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ focussing on a specific API aspect to test or verify


> **Note**
> In the following overview some invocation examples are given as basic reference.
> In the following overview includes some invocation examples that are given as basic reference.
> Make sure to also check the more [detailed documentation of the test run options](#run-options) further in the docs.

Expand Down Expand Up @@ -109,7 +109,7 @@ activate the virtual environment in your shell with:
source venv/bin/activate
```

### Install openeo-test-suite package (with dependencies)
### Install `openeo-test-suite` package (with dependencies)

Install the project and its dependencies in your virtual environment with:

Expand Down Expand Up @@ -178,8 +178,8 @@ If both are specified, the union of both will be considered.
### Runner for individual process testing <a name="individual-process-testing-runner"></a>
One module of the test suite is dedicated to **individual process testing**,
where each process is tested individually with a given set of inputs and expected outputs.
The goal of the **individual process testing** module of the test suite
is testing each openEO process individually with one or more pairs of input and expected output.
Because there are a lot of these tests (order of thousands),
it is very time-consuming to run these through the standard, HTTP based openEO REST API.
As a countermeasure, the test suite ships with several experimental **runners**
Expand Down

0 comments on commit 8b3faa4

Please sign in to comment.