Skip to content

Commit ea6d50e

Browse files
committed
Update documentation for isbn() Fix function. (#233)
1 parent 22ca5a8 commit ea6d50e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -517,15 +517,16 @@ uniq("<sourceField>")
517517

518518
#### `isbn`
519519

520-
Transforms and optionatily checks ISBN if correct.
520+
Extracts an ISBN and replaces the field value with the normalized ISBN; optionally converts and/or validates the ISBN.
521521

522522
Options:
523-
- `to`: either to `"ISBN13"`,`"ISBN10"` or `"clean"`(deleting semantic sugar)
524-
- `verify_check_digit`: default `"false"`
525-
- `error_string`: if check digit is wrong provide error message
523+
524+
- `to`: ISBN format to convert to (either `ISBN10` or `ISBN13`). (Default: Only normalize ISBN)
525+
- `verify_check_digit`: Whether the check digit should be verified. (Default: `false`)
526+
- `error_string`: Error message as a placeholder if the ISBN couln't be validated. (Default: `null`)
526527

527528
```perl
528-
isbn("<sourceField>",to:"<IsbnTransformation>"[,verify_check_digit:"<boolean>",error_string:"<errorMessage>"])
529+
isbn("<sourceField>"[, to: "<isbnFormat>"][, verify_check_digit: "<boolean>"][, error_string: "<errorValue>"])
529530
```
530531

531532
### Selectors

0 commit comments

Comments
 (0)