saem / vscode-nim

Other
177 stars 23 forks source link

runnableExamples are not included when showing the docs #67

Open rtdietrich opened 2 years ago

rtdietrich commented 2 years ago

If I use code-blocks like here: Plug-in-Issue-04-code-block

It will be showing up like here:

Plug-in-Issue-01

The Point is: Under https://github-wiki-see.page/m/nim-lang/Nim/wiki/Best-practices and on other Sites too, it is suggested to use runnable Examples when ever possible. Unfortunally your Plug-in doesn't support it right now. Or is it a bug?

If I got a Code like this: Plug-in-Issue-04-runnableexamples

It will not showing up when using your plug-in.

Any help for this?

saem commented 2 years ago

Excellent issue, thanks for raising it.

I'm pretty sure this is a limitation of nimsuggest, runable examples aren't provided during the suggestion process. First the compiler/suggest would have to be fixed.

I've stopped fixind compiler issues directly, once that's been fixed then it should be relatively seamless.