Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render math in R completion popups and help #33

Open
kevinushey opened this issue Oct 14, 2022 · 5 comments
Open

Render math in R completion popups and help #33

kevinushey opened this issue Oct 14, 2022 · 5 comments
Labels
area: completions Issues related to Completions area: editor Issues related to Editor category. lang: r

Comments

@kevinushey
Copy link
Contributor

For example, the help for rnorm as viewed in RStudio:

Screen Shot 2022-10-14 at 4 31 48 PM

VSCode appears to only accept Markdown and plain text by default, though. Here's that that looks like with a naive HTML-to-Markdown implementation with Pandoc.

Screen Shot 2022-10-14 at 4 32 40 PM

@kevinushey
Copy link
Contributor Author

@kevinushey
Copy link
Contributor Author

Alternatively, we can limit the amount of help we show in the completion popups to a smaller subset and just let a separate Help pane manage the display of arbitrary help HTML.

@kevinushey
Copy link
Contributor Author

Here's how things look currently:

Screenshot 2023-02-14 at 2 25 34 PM

This is probably good enough for MVP, but I think we'll eventually want a way to make sure that we render latex / MathJax appropriately.

@kevinushey kevinushey added this to the Public Beta milestone Feb 15, 2023
@petetronic petetronic changed the title should we allow HTML within completion help popups? Render math in R completion popups and help Feb 15, 2024
@wesm wesm added area: editor Issues related to Editor category. lang: r labels Feb 29, 2024
@lionel- lionel- added the area: completions Issues related to Completions label May 17, 2024
@Fred-Wu
Copy link

Fred-Wu commented Jul 11, 2024

Would this be made to Python too? For example , in torch, it currently shows:

image

@juliasilge
Copy link
Contributor

@Fred-Wu I believe the Python support is tracked in #1522, if you'd care to add details or an example there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: completions Issues related to Completions area: editor Issues related to Editor category. lang: r
Projects
None yet
Development

No branches or pull requests

6 participants