Skip to content

Commit 4a674ef

Browse files
committed
Format options documentation #265
1 parent 7388238 commit 4a674ef

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ nothing()
177177

178178
##### `put_filemap`
179179

180-
Defines an external map for lookup from a file. Multi-column mapss are supported.
180+
Defines an external map for lookup from a file. Maps with more than 2 columns are supported but are reduced to a defined key and a value column.
181181

182182
```perl
183183
put_filemap("<sourceFile>", "<mapName>", sep_char: "\t")
@@ -190,15 +190,15 @@ The separator (`sep_char`) will vary depending on the source file, e.g.:
190190
| CSV | `,` or `;` |
191191
| TSV | `\t` |
192192

193-
Additional options:
193+
Options:
194194

195-
- `key_column` defines the column to be used for keys. Uses zero index. Default value: `0`.
196-
- `value_column` defines the column to be used for values. Uses zero index. Default value: `1`.
197-
- `expected_columns` sets number of expected columns; lines with different number of columns are ignored. Set to `-1` to disable the check and allow arbitrary number of columns. Default value: `2`.
198-
- `allow_empty_values` sets whether to allow empty values in the filemap or to ignore these entries. Default value: `false`.
199-
- `compression` sets the compression of the file.
200-
- `decompress_concatenated` flags whether to use decompress concatenated file compression.
201-
- `encoding` sets the encoding used to open the resource.
195+
- `allow_empty_values`: Sets whether to allow empty values in the filemap or to ignore these entries. (Default: `false`)
196+
- `compression`: Sets the compression of the file.
197+
- `decompress_concatenated`: Flags whether to use decompress concatenated file compression.
198+
- `encoding`: Sets the encoding used to open the resource.
199+
- `expected_columns`: Sets number of expected columns; lines with different number of columns are ignored. Set to `-1` to disable the check and allow arbitrary number of columns. (Default: `2`)
200+
- `key_column`: Defines the column to be used for keys. Uses zero index. (Default: `0`)
201+
- `value_column`: Defines the column to be used for values. Uses zero index. (Default: `1`)
202202

203203
##### `put_map`
204204

0 commit comments

Comments
 (0)