Skip to content

Commit

Permalink
Refactor docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jul 24, 2017
1 parent ab6bd8c commit 029fb20
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,16 +108,22 @@ RootNode[2] (1:1-6:1, 0-134)
Transform a [HAST][] syntax tree and corresponding [virtual file][vfile]
into an [NLCST][nlcst] tree.

###### Parameters
##### Parameters

* `node` ([`HASTNode`][hast])
— Syntax tree (with positional information)
* `file` ([`VFile`][vfile])
* `parser` (`Function`)
— Constructor of an NLCST parser, such as [**parse-english**][english],
[**parse-dutch**][dutch], or [**parse-latin**][latin]
###### `node`

###### Returns
Syntax tree with positional information ([`HASTNode`][hast]).

###### `file`

Virtual file ([`VFile`][vfile]).

###### `parser`

Constructor of an NLCST parser, such as [`parse-english`][english],
[`parse-dutch`][dutch], or [`parse-latin`][latin] (`Function`).

##### Returns

[`NLCSTNode`][nlcst].

Expand Down

0 comments on commit 029fb20

Please sign in to comment.