Commit 9f060cd7 authored by Knut Behrends's avatar Knut Behrends
Browse files

improve clarity of USAGE.md

parent 164224be
......@@ -107,14 +107,14 @@ To insert a single new hole, call the script without arguments:
`bin/api-caller-hole.sh`
Do *not* change the line
`num_holes=1` if you want to add more than 1 site.
`num_holes=1` if you want to add more than 1 hole.
Instead, you must change file `src/hole-inserter.js`. In there, change the lines
`let num_holes_to_insert = 1` and
`let site_id = 6`
accordingly, if you want to add any holes to that site.
You can get the valuue of the site-id from the mDIS site-form, or from an SQL query.
You can get the value of the site-id from the mDIS site-form, or from an SQL query.
-----
......@@ -139,10 +139,10 @@ You can get the ids from the respective mDIS form, or from an SQL query.
Error `Data Validation Failed`:
- Invalid combination of -e, -s, -h.
- Invalid combination of values for -e, -s, -h.
- Something else is wrong (mandatory fields missing?).
Copy the returned JSON structure and insert it into Postman, test the API response. The HTTP response will be easier to work with, and the error message will be more verbose, and easier to understand.
Copy the returned JSON structure and insert it into Postman, test the API response. The HTTP response returned by Postman will be easier to work with. The error message will be more verbose, and easier to understand.
-----
......@@ -228,7 +228,7 @@ core 1: 4 sections
Splits get inserted core-by-core.
> Single Core:
##### Single Core
Command for splitting all sections of a single core:
......@@ -240,12 +240,13 @@ Command for splitting all sections of a single core:
```
> Many Cores:
##### Many Cores
(write a bash for-loop of you need to insert splits for more than one core:
`for i in $(seq 1 10);do ./api-caller-sectionsplit-insert.sh -c $i; done )`
or see `bin/api-caller-sectionsplit-insert-loop.sh`.
Expected outputs:
##### Single Core - Expected outputs
Core was _not_ split before:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment