Skip to content

Commit 2f0494b

Browse files
committed
Add improved jsdoc
1 parent 1ee0c28 commit 2f0494b

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

index.js

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,16 @@
99
import {visitParents} from 'unist-util-visit-parents'
1010

1111
/**
12-
* Visit children of tree which pass a test
12+
* Visit children of tree which pass test.
1313
*
14-
* @param tree Abstract syntax tree to walk
15-
* @param test Test, optional
16-
* @param visitor Function to run for each node
17-
* @param reverse Visit the tree in reverse, defaults to false
14+
* @param tree
15+
* Tree to walk
16+
* @param [test]
17+
* `unist-util-is`-compatible test
18+
* @param visitor
19+
* Function called for nodes that pass `test`.
20+
* @param reverse
21+
* Traverse in reverse preorder (NRL) instead of preorder (NLR) (default).
1822
*/
1923
export const visit =
2024
/**
@@ -53,4 +57,5 @@ export const visit =
5357
}
5458
}
5559
)
60+
5661
export {CONTINUE, EXIT, SKIP} from 'unist-util-visit-parents'

0 commit comments

Comments
 (0)