Skip to content

Commit e9c41e8

Browse files
committed
Improve processing test documentation
1 parent 81744ec commit e9c41e8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

python/plugins/processing/tests/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ A basic test appears under the toplevel key `tests` and looks like this:
2222
How To
2323
------
2424
25-
To add a new test you can follow these steps:
25+
To add a new test please follow these steps:
2626
27-
Run the algorithm you want to test in QGIS from the processing toolbox. If the
27+
1. **Run the algorithm** you want to test in QGIS from the processing toolbox. If the
2828
result is a vector layer prefer GML as output for its support of mixed
2929
geometry types and good readability. Redirect output to
30-
`python/plugins/processing/tests/testdata/expected`
30+
`python/plugins/processing/tests/testdata/expected`. For input layers prefer to use what's already there in the folder `testdata`. If you need extra data, put it into `testdata/custom`.
3131

32-
When you have run the algorithm, go to "Processing" > "History" and find the
33-
algorithm which you have just run. Right click the algorithm and click "Create test".
32+
2. When you have run the algorithm, go to *Processing* > *History* and find the
33+
algorithm which you have just run. **Right click the algorithm and click "Create Test"**.
3434
A new window will open with a text definition.
3535

36-
Open the file `python/plugins/processing/tests/testdata/algorithm_tests.yaml`,
37-
copy the text definition there.
36+
3. Open the file `python/plugins/processing/tests/testdata/algorithm_tests.yaml`,
37+
**copy the text definition** there.
3838

3939
The first string from the command goes to the key `algorithm`, the subsequent
4040
ones to params and the last one(s) to results.

0 commit comments

Comments
 (0)