Skip to content

Commit

Permalink
Remove outdated description of compile results
Browse files Browse the repository at this point in the history
Closes GH-105.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
  • Loading branch information
inokawa authored Nov 5, 2020
1 parent 9b0741b commit ad12369
Showing 1 changed file with 0 additions and 7 deletions.
7 changes: 0 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -647,13 +647,6 @@ The parsed, transformed, and compiled value is exposed on

`process` performs the [*parse*, *run*, and *stringify* phases][description].

Be aware that [*compiler*][compiler]s typically, but not always, return
`string`.
Some compilers, such as the one configured with [`rehype-react`][rehype-react],
return other values (in this case, a React tree).
When using TypeScript, cast the type of [`file.contents`][vfile-contents] on
your side.

unified typically compiles by serializing: most [*compiler*][compiler]s return
`string` (or `Buffer`).
Some compilers, such as the one configured with [`rehype-react`][rehype-react],
Expand Down

0 comments on commit ad12369

Please sign in to comment.