mirror of
https://github.com/ilri/csv-metadata-quality.git
synced 2024-12-22 20:22:18 +01:00
README.md: Improve note about unsafe options
This commit is contained in:
parent
8d92498bbf
commit
0eb852a65b
@ -47,7 +47,7 @@ To validate and clean a CSV file you must specify input and output files using t
|
|||||||
$ python -m csv_metadata_quality -i data/test.csv -o /tmp/test.csv
|
$ python -m csv_metadata_quality -i data/test.csv -o /tmp/test.csv
|
||||||
```
|
```
|
||||||
|
|
||||||
You can enable "unsafe fixes" with the `--unsafe-fixes` option. This will attempt to fix things like invalid multi-value separators ("|"). It's possible that a metadata value could legitimately use "|" but in my experience this is rather always an error where the user meant to enter multiple values for a field, for example `Kenya||Tanzania`.
|
You can enable "unsafe fixes" with the `--unsafe-fixes` option. Currently this will attempt to fix things like invalid multi-value separators (`|`). This is considered "unsafe" because it's theoretically possible for the `|` to be used legitimately in a metadata value, but in my experience it's always a typo where the user was attempting to use multiple metadata values, for example: `Kenya|Tanzania`.
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user