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.

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

F1 doesn't open help panel in Quarto chunk #4097

Closed
Tracked by #4858
andrewheiss opened this issue Jul 20, 2024 · 9 comments
Closed
Tracked by #4858

F1 doesn't open help panel in Quarto chunk #4097

andrewheiss opened this issue Jul 20, 2024 · 9 comments
Assignees
Labels
area: help Issues related to Help category. area: quarto Issues related to Quarto category. bug Something isn't working support

Comments

@andrewheiss
Copy link

Positron Version:

Positron Version: 2024.07.0 (Universal) build 41
Code - OSS Version: 1.90.0
Commit: 9f24124
Date: 2024-07-12T04:30:16.648Z
Electron: 29.4.0
Chromium: 122.0.6261.156
Node.js: 20.9.0
V8: 12.2.281.27-electron.0
OS: Darwin arm64 23.5.0


I'm not sure if this is a Quarto extension issue or a Positron issue, or if it's related to #3753, but the F1 shortcut for help doesn't seem to work in R chunks in Quarto documents on macOS. The documentation does show up when hovering over function names, and running ?whatever in the console works fine too—it's just the F1 shortcut that doesn't do anything (and doesn't emit any console messages either)

Here's a little video:

quarto.help.mov

Steps to reproduce the issue:

  1. Make an R chunk in a Quarto document and type an R function name
  2. Place the cursor in the function name and type F1

What did you expect to happen?

I was hoping the help panel would appear

Were there any error messages in the Output panel or Developer Tools console?

Nope!

@andrewheiss andrewheiss added the bug Something isn't working label Jul 20, 2024
@juliasilge
Copy link
Contributor

We had a related problem in #1645 where all language features didn't work and thought we had fixed that, including F1 help.

@juliasilge juliasilge added area: help Issues related to Help category. area: quarto Issues related to Quarto category. lang: r support labels Jul 22, 2024
@andrewheiss
Copy link
Author

Huh, weird! All other language features work in both source and visual editor modes, just not F1

source-visual.mov

@juliasilge
Copy link
Contributor

This is not an R only problem. For Python as well, F1 help works in a regular .py file but does not work in a Quarto file.

@juliasilge juliasilge changed the title F1 doesn't open help panel in R chunk in Quarto F1 doesn't open help panel in Quarto chunk Jul 22, 2024
@juliasilge juliasilge added this to the 2024.10.0 Pre-Release milestone Jul 22, 2024
@FinYang
Copy link

FinYang commented Oct 21, 2024

Not sure if this is related but my F1 opened a help window in the explorer called QUARTO: HELP

Image

@andrewheiss
Copy link
Author

Ahhhhh cool I'd never noticed that! It looks like the Quarto extension is hijacking the Positron help panel. I opened an issue over there to link these things: quarto-dev/quarto#580

@juliasilge juliasilge self-assigned this Nov 6, 2024
juliasilge added a commit that referenced this issue Nov 7, 2024
Addresses #4097

Goes together with quarto-dev/quarto#599; the
Quarto PR is needed to actually see this work but this PR should be able
to be merged on its own.

### QA Notes

In a Quarto file, you should be able to use <kbd>F1</kbd> to bring up
help for R like so:


![help-quarto](https://github.com/user-attachments/assets/e23c6a23-f0c5-404e-8284-1274c7c66b8b)

This is only working right now for R, because of
#5290. When we fix that, we
should also confirm it works in a `.qmd` as well.
@mrzeszut

This comment has been minimized.

@juliasilge

This comment has been minimized.

@juliasilge
Copy link
Contributor

QA Notes

To see this fixed, you will need both the version of Positron that has #5292 and the version of the Quarto extension that has quarto-dev/quarto#599.

Note

Heads up to our valued beta folks! This isn't in a publicly available build of Positron as of my writing but will be early next week.

You can get the appropriate version of the Quarto version from the artifact here (download, unzip, install the .vsix, restart Positron). Then you can use F1 to bring up Positron help in a .qmd that uses R.

Python does not work because F1 help is broken for Python entirely as now tracked in #5290.

I did not change anything about the quarto-assist webview, which is what is shown in #4097 (comment). I don't believe that was ever bound to F1 in Quarto but rather it is bound to Cmd/Ctrl+F1.

Given that we made some other architectural changes in quarto-dev/quarto#599, it would also be great to run through a bit of spot testing of hover, statement range provider, signature help, and completions in .qmd files. I have also checked all these, but not a bad idea for someone else to confirm!

@jonvanausdeln
Copy link
Contributor

Verified Fixed

Positron Version(s) : 2024.12.0-21
OS Version(s) : Windows 11

Test scenario(s)

F1 opens help as expected R quarto chunk

Link(s) to TestRail test cases run or created:

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area: help Issues related to Help category. area: quarto Issues related to Quarto category. bug Something isn't working support
Projects
None yet
Development

No branches or pull requests

5 participants