diff --git a/README.md b/README.md index 359f728..baf2a26 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,13 @@ poetry add --dev pytest-csv-params Simply decorate your test method with `@csv_params` and the following parameters: -| Parameter | Type | Description | Example | -|--------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| -| `data_file` | `str` | The CSV file to use, relative or absolute path | `/var/testdata/test1.csv` | -| `base_dir` | `str` (optional) | Directory to look up relative CSV files (see `data_file`); overrides the command line argument | `join(dirname(__file__), "assets")` | -| `id_col` | `str` (optional) | Column name of the CSV that contains test case IDs | `"ID#"` | -| `dialect` | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab` | -| `data_casts` | `dict` (optional) | Cast Methods for the CSV Data (see "Data Casting" below) | `{ "a": int, "b": float }` | +| Parameter | Type | Description | Example | +|--------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| `data_file` | `str` | The CSV file to use, relative or absolute path | `"/var/testdata/test1.csv"` | +| `base_dir` | `str` (optional) | Directory to look up relative CSV files (see `data_file`); overrides the command line argument | `join(dirname(__file__), "assets")` | +| `id_col` | `str` (optional) | Column name of the CSV that contains test case IDs | `"ID#"` | +| `dialect` | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab` | +| `data_casts` | `dict` (optional) | Cast Methods for the CSV Data (see "Data Casting" below) | `{ "a": int, "b": float }` | ### CSV File Lookup Order