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.

Sign up for GitHub

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

Jump to bottom

R: Include help documentation for function parameters in completion list #1615

Open
Tracked by #1603
kevinushey opened this issue Oct 17, 2023 · 1 comment
Open
Tracked by #1603

R: Include help documentation for function parameters in completion list #1615

kevinushey opened this issue Oct 17, 2023 · 1 comment
Labels
area: completions Issues related to Completions area: kernels Issues related to Jupyter kernels and LSP servers lang: r
Milestone
Release Candidate

Comments

@kevinushey
Copy link
Contributor

We should provide the documentation related to that specific function argument, for argument-name completions. For example:

Screenshot 2023-10-17 at 1 58 54 PM

Which we could (in theory) grab by parsing the help documentation for boundary.

Screenshot 2023-10-17 at 1 59 39 PM
@kevinushey kevinushey changed the title R: Include documentation for function parameters R: Include help documentation for function parameters in completion list Oct 17, 2023
@DavisVaughan DavisVaughan mentioned this issue Nov 16, 2023
Open
23 tasks
@jennybc jennybc added this to the Release Candidate milestone Feb 23, 2024
@wesm wesm added the lang: r label Feb 29, 2024
@lionel- lionel- added area: kernels Issues related to Jupyter kernels and LSP servers area: completions Issues related to Completions labels May 16, 2024
@DavisVaughan
Copy link
Contributor

See also #4046, where we already have some infrastructure for parsing the HTML help docs and showing the per argument help info in the Signature Help tooltip, so we can probably reuse that here.

It is utilized here to match the argument name to an argument name extracted from the HTML
https://github.com/posit-dev/ark/blob/bf1e6cdf0164369ce59849e17e7e250c58cf3fb3/crates/ark/src/lsp/help.rs#L194-L205

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: completions Issues related to Completions area: kernels Issues related to Jupyter kernels and LSP servers lang: r
Projects
None yet
Milestone
Release Candidate
Development

No branches or pull requests
5 participants
@wesm @jennybc @kevinushey @lionel- @DavisVaughan