Skip to content
This repository has been archived by the owner on Nov 16, 2021. It is now read-only.

Revise documentation hovering #12

Open
jeapostrophe opened this issue Oct 23, 2020 · 2 comments
Open

Revise documentation hovering #12

jeapostrophe opened this issue Oct 23, 2020 · 2 comments

Comments

@jeapostrophe
Copy link
Contributor

Right now, you're doing a manual process to get the documentation. However, we could modify the Reach documentation generator (https://github.com/reach-sh/reach-lang/tree/539a63081329e64638fc8776eeef2b2a26c993f7/docs-src) to (a) generate a Markdown version and (b) provide a cross-reference file with all of the tokens with corresponding links to the documentation. I'm not sure what the constraints of VSCode are, but I'd love to help you make it better.

@ericglau
Copy link
Contributor

ericglau commented Oct 23, 2020

The doc for the supported Markdown format is here. Having tokens to map to the corresponding Markdown text in an automated way would be great.

It would also be good to have some context for what is treated as a particular token (for example, whether it is an identifier or a step). I would need to consider how this context can be represented programatically though.

@hamirmahal
Copy link
Contributor

I think we should fix the formatting for some of the keywords. Reach.App looks like this:

Screen Shot 2021-09-30 at 8 49 27 AM

Other keywords' hover descriptions look fine. Particpant's hover text is fine, for instance.

Screen Shot 2021-09-30 at 8 50 56 AM

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants