Skip to content

Improve Help Panel#470

Merged
ManuelHentschel merged 15 commits intoREditorSupport:masterfrom
ManuelHentschel:helppanel
Nov 28, 2020
Merged

Improve Help Panel#470
ManuelHentschel merged 15 commits intoREditorSupport:masterfrom
ManuelHentschel:helppanel

Conversation

@ManuelHentschel
Copy link
Copy Markdown
Member

@ManuelHentschel ManuelHentschel commented Nov 26, 2020

Improve the help panel and fix #471:

  • Remove use of isFALSE
  • Fix some bugs that caused the entire extension to crash, if the help panel path was invalid
  • Parse package index to suggest package names when calling R: Show Help
  • Parse index files of packages to suggest documented functions from a selected package
  • Implement ?? functionality
    • Accessible with command R: Search Help or by selecting search icon after command R: Show Help
    • Make accessible from R session
  • Improve performance:
    • Cache installed packages/functions in package per session
    • Keep cache between sessions?
    • Add option to clear cached index files
  • Implement ? functionality (from vscode command palette)
  • Identify and highlight package pages like e.g. base/html/base-package.html
  • ...

Copy link
Copy Markdown
Member

@renkun-ken renkun-ken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thanks for the nice improvements!

The package and topics picking in "Show help" commands works quite nicely!

@ManuelHentschel
Copy link
Copy Markdown
Member Author

Thanks for the feedback. Regarding the to remaining items on the checklist:

Implement ? functionality (from vscode command palette)

I started working on this, but it seems to be a bit more complicated, so I'll do this in a separate PR

Keep cache between sessions?

This would make sense for people with many installed packages on slower computers, but might complicate things for people working with different package versions/environments. For now I'd skip this feature and implement it later if necessary.

@ManuelHentschel ManuelHentschel changed the title WIP: Improve Help Panel Improve Help Panel Nov 27, 2020
@ManuelHentschel ManuelHentschel marked this pull request as ready for review November 27, 2020 10:35
Comment thread src/rHelpProviderCustom.ts Outdated
@ManuelHentschel ManuelHentschel merged commit c5820f8 into REditorSupport:master Nov 28, 2020
@ManuelHentschel ManuelHentschel deleted the helppanel branch November 28, 2020 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

R < 3.5.0 will error when loading help files due to lack of isFALSE()

2 participants