Skip to content

Improve R documentation integration聽#204

Closed
Closed
Improve R documentation integration#204
Labels
feature-request

Description

@ghost
ghost
opened on Jan 27, 2020

First of all thanks a big thanks to all the contributors of this project. I recently started using vscode-R and it starting to be a very solid alternative to Rstudio, it is also good to see the project getting new features every week 馃憤.

I would like to submit a couple suggestions to improve the user experience with the R documentation:

  • Add a command r.help to vscode-R in the spirit of r.head so that the selected function name in the editor can be sent to the console with r help(<selected_text>), this would allow users to map shortcuts to it and quickly jump to the help page.
  • Add the possibility to copy text from the R documentation in the html viewer in order to be able to paste it into the console or the text editor (e.g. I often do this with examples, function names, argument names, etc.).
  • Add a search bar in the html documentation viewer.
  • Add a black theme option to the html viewer possibly linked to the editor background color (Better support of dark theme in WebViews聽#178).

Thanks

Activity

  1. ghost added
    feature-request
    on Jan 27, 2020

  2. renkun-ken commented on Jan 27, 2020

    @renkun-ken
    renkun-ken
    on Jan 27, 2020
    Member

    Thanks for your suggestions!

    Add a command r.help to vscode-R in the spirit of r.head so that the selected function name in the editor can be sent to the console with r help(<selected_text>), this would allow users to map shortcuts to it and quickly jump to the help page.

    This looks like a special case of #201.

    Add the possibility to copy text from the R documentation in the html viewer in order to be able to paste it into the console or the text editor (e.g. I often do this with examples, function names, argument names, etc.).

    This is currently limited by the user operations allowed by WebView. See microsoft/vscode#65452.

    Add a search bar in the html documentation viewer.

    I'm not sure if it is possible to do this because the R documentation is purely provided by a http server started from R. The WebView just shows the URL triggerred by browser. It does nothing else and it even cannot know it is help documentation.

    Add a black theme option to the html viewer possibly linked to the editor background color (#178).

    I'm trying to figure out but I don't know a robust way to do this at the moment.

  4. StepanSushko commented on Feb 20, 2020

    @StepanSushko
    StepanSushko
    on Feb 20, 2020

    I'm trying to figure out but I don't know a robust way to do this at the moment.

    Could you add such option in settings of the extensions at least by default switched off, please?

    As a more solid solution, I would suggest just to create or pick existing theme which works fine and just to recommend it in description of the extension.

  5. pat-s commented on Mar 29, 2020

    @pat-s
    pat-s
    on Mar 29, 2020

    The WebView just shows the URL triggerred by browser. It does nothing else and it even cannot know it is help documentation.

    It's really funny that on the one hand vscode can do SO MUCH but at the same time fails to provide search within the default HTML previewer 馃槄

  6. renkun-ken commented on Jun 27, 2021

    @renkun-ken
    renkun-ken
    on Jun 27, 2021
    Member

    Closing as the help pages are supported now.

  7. renkun-ken
    closed this as completedon Jun 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature-request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions