Skip to content

Commit a804b8c

Browse files
committed
Update documentation.
- Fix `lookup()` option `id`. (dec5b36) - Link to `lookup()` from `put_*map()`.
1 parent 72196e7 commit a804b8c

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 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. Maps with more than 2 columns are supported but are reduced to a defined key and a value column.
180+
Defines an external map for [lookup](#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")
@@ -202,7 +202,7 @@ Options:
202202

203203
##### `put_map`
204204

205-
Defines an internal map for lookup from key/value pairs.
205+
Defines an internal map for [lookup](#lookup) from key/value pairs.
206206

207207
```perl
208208
put_map("<mapName>",
@@ -574,7 +574,7 @@ Additional options when printing unknown values:
574574
- `encoding` (file output only): Encoding used by the underlying writer. (Default: `UTF-8`)
575575
- `footer`: Footer which is written at the end of the output. (Default: `\n`)
576576
- `header`: Header which is written at the beginning of the output. (Default: Empty string)
577-
- `id`: Field name which contains the record ID; if found, will be available for inclusion in `destination`. (Default: `_id`)
577+
- `id`: Field name which contains the record ID; if found, will be available for inclusion in `prefix` and `destination`. (Default: `_id`)
578578
- `prefix`: Prefix to print before the unknown value; may include [format directives](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html#syntax) for counter and record ID (in that order). (Default: Empty string)
579579
- `separator`: Separator which is written after the unknown value. (Default: `\n`)
580580

0 commit comments

Comments
 (0)