SwissFEL/sanipy
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

typos

Browse Source
This commit is contained in:
augustin_s
2020-09-23 11:28:16 +02:00
parent ca5667796b
commit 181e0a2e07
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -10,7 +10,7 @@ The `data` folder contains some channel lists and output files for testing.
Reads a list of PV names from plain text file (comments starting with `#` are allowed, even recommended) and tests each channel for connection, alarm status and severity. Reads a list of PV names from plain text file (comments starting with `#` are allowed, even recommended) and tests each channel for connection, alarm status and severity.
For each channel, the result will be printed as soon as it arrived. Thus, the output is ordered by response time. There is a command line switch to suppress the output (`-s`/`--silent`) and to set the connection time out in seconds (`-t`/`--timeout`). For each channel, the result will be printed as soon as it arrived. Thus, the output is ordered by response time. There is a command-line switch to suppress the output (`-s`/`--silent`) and to set the connection time out in seconds (`-t`/`--timeout`).
The test result can be written to a comma-separated values (csv) file by giving a filename to the `-o`/`--output` switch (`.csv` is automatically appended to the filename if missing). The test result can be written to a comma-separated values (csv) file by giving a filename to the `-o`/`--output` switch (`.csv` is automatically appended to the filename if missing).
@ -31,7 +31,7 @@ Reads two csv files produced via [check](#check), and prints the differences (if
Values are, on the one hand, likely to change between checks. However, this change does, on the other hand, not necessarily indicate a problem. Thus, there is a switch (`-v`/`--ignore-values`) to ignore them in the comparison. Values are, on the one hand, likely to change between checks. However, this change does, on the other hand, not necessarily indicate a problem. Thus, there is a switch (`-v`/`--ignore-values`) to ignore them in the comparison.
###example output ### example output
`./sani.py compare data/test1.csv data/test4 --ignore-values` `./sani.py compare data/test1.csv data/test4 --ignore-values`
<br> <br>