Skip to content

Commit 0582c7c

Browse files
committed
Refactor docs
1 parent f7904ac commit 0582c7c

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

readme.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,19 @@ RootNode[1] (1:1-1:17, 0-16)
5151
Transform an [MDAST][] syntax tree and corresponding [virtual file][vfile]
5252
into an [NLCST][nlcst] tree.
5353

54-
###### Parameters
54+
##### Parameters
5555

5656
* `node` ([`MDASTNode`][mdast])
5757
— Syntax tree (with positional information)
5858
* `file` ([`VFile`][vfile])
59-
* `parser` (`Function`)
60-
— Constructor of an NLCST parser, such as [**parse-english**][english],
61-
[**parse-dutch**][dutch], or [**parse-latin**][latin]
6259

63-
###### Returns
60+
##### `parser`
61+
62+
Constructor of an NLCST parser (`Function`). For example,
63+
[`parse-english`][english], [`parse-dutch`][dutch], or
64+
[`parse-latin`][latin].
65+
66+
##### Returns
6467

6568
[`NLCSTNode`][nlcst].
6669

0 commit comments

Comments
 (0)