Skip to content

Commit 52f134b

Browse files
committed
Fix metadata
1 parent 32f11e4 commit 52f134b

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "hast-util-excerpt",
33
"version": "0.0.0",
4-
"description": "hast utility to excerpt the tree to a certain number of characters",
4+
"description": "hast utility to excerpt the tree to a comment",
55
"license": "MIT",
66
"keywords": [
77
"unist",

readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Backers][backers-badge]][collective]
99
[![Chat][chat-badge]][chat]
1010

11-
**[hast][]** utility to excerpt the tree to a certain number of characters.
11+
**[hast][]** utility to truncate the tree to a comment.
1212

1313
## Install
1414

@@ -72,7 +72,7 @@ There is no default export.
7272

7373
### `excerpt(tree, options?)`
7474

75-
Excerpt the tree to a certain number of characters.
75+
Truncate the tree to a comment.
7676

7777
###### `options.comment`
7878

@@ -93,7 +93,7 @@ These are not counted towards `size`.
9393

9494
###### Returns
9595

96-
`Node` — Truncated copy of `tree`
96+
`Node?` — Truncated copy of `tree` if there’s a comment, `undefined` otherwise.
9797

9898
## Security
9999

0 commit comments

Comments
 (0)