posit-dev / posit-dev/positron

Render math in R completion popups and help

Open
#33 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area: completions area: editor lang: r
Dominant language
TypeScript
Stars
4.3k
Forks
183
Avg merge
1d 11h
Merged PRs (30d)
206

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names completion popups and help views but no files or tests. Start by locating those rendering entry points in the Positron TypeScript client and review the Markdown/plain-text behavior described for VS Code. Done means mathematical notation from R help renders correctly in both completion popups and help.

Written by the indexing model from the issue text.

Assessment

Tech stack
r, typescript, vscode
Domain
desktop, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.