Skip to content

Commit ff65f14

Browse files
committed
Document eval plugin limitations
- mention std[in|out|err] problems - link to differences with doctest
1 parent eeb1d20 commit ff65f14

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/features.md

+7
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,13 @@ Evaluates code blocks in comments with a click. [Tutorial](https://github.com/ha
274274

275275
![Eval Demo](https://raw.githubusercontent.com/haskell/haskell-language-server/master/plugins/hls-eval-plugin/demo.gif)
276276

277+
Known limitations:
278+
279+
- Standard input is shared with HLS, so e.g. [`getLine` breaks the connection to server](https://github.com/haskell/haskell-language-server/issues/2913).
280+
- Standard (error) output [is not captured](https://github.com/haskell/haskell-language-server/issues/1977).
281+
- While similar to [doctest](https://hackage.haskell.org/package/doctest), some of its features are unsupported,
282+
see [Differences with doctest](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-eval-plugin/README.md#differences-with-doctest).
283+
277284
### Make import lists fully explicit code lens
278285

279286
Provided by: `hls-explicit-imports-plugin`

0 commit comments

Comments
 (0)