REditorSupport / REditorSupport/vscode-R
Documentation from devtools-loaded package opens in web browser
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.2k
- Forks
- 139
- Avg merge
- 2h 46m
- Merged PRs (30d)
- 5
Description
Steps to reproduce:
- Open some R package project in vscode.
- Spin up an R terminal.
- Issue "r.loadAll" from https://github.com/REditorSupport/vscode-R/wiki/Package-development
- Try to browse the documentation of some function from the loaded package by issuing
?the_function.
Expected behavior: should show me the documentation in the top-right pane, same as it does for documentation of functions from installed packages.
Actual behavior: launches a web browser to view the documentation, and it's not even the default web browser that I have configured in my system.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce this in an R package project by following the Package-development wiki: open an R terminal, run r.loadAll, and query ?the_function. Compare documentation from the loaded package with documentation from an installed package, focusing on why one opens externally instead of in the top-right pane. Done means loaded-package documentation uses the same in-editor view and no longer launches an unexpected browser.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r, typescript, vscode
- Domain
- developer-experience, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100