Skip to content

Commit 1c70044

Browse files
committed
Refactor API description
1 parent 61263c3 commit 1c70044

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

readme.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,17 @@ normalize({
3434

3535
### `normalize(value[, options])`
3636

37-
Normalize a word (often a node) for easier comparison. Always
38-
normalises smart apostrophes (``) to straight apostrophes (`'`).
39-
And, lowercases alphabetical characters (`[A-Z]`).
37+
Normalize a word (`string`, [`Node`][node], `Array.<Node>`) for easier
38+
comparison. Always normalises smart apostrophes (``) to straight
39+
apostrophes (`'`) and lowercases alphabetical characters (`[A-Z]`).
4040

41-
###### Parameters
41+
###### `options.allowApostrophes`
4242

43-
* `value` ([`Node`][node], `Array.<Node>`, or `string`)
44-
— Value to normalize;
45-
* `options` (`Object?`):
43+
`boolean`, default: `false` — Do not strip apostrophes (`'`).
4644

47-
* `allowApostrophes` (`boolean`, default: `false`)
48-
— Do not strip apostrophes (`'`);
49-
* `allowDashes` (`boolean`, default: `false`)
50-
— Do not strip hyphens (`-`).
45+
###### `options.allowDashes`
5146

52-
###### Returns
53-
54-
`string` — Normalized value.
47+
`boolean`, default: `false` — Do not strip hyphens (`-`).
5548

5649
## License
5750

0 commit comments

Comments
 (0)