quarto-dev / quarto-dev/quarto
VScode extension: Quarto HELP pane does not provide documentation in some cases
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 645
- Forks
- 62
- Avg merge
- 17h 42m
- Merged PRs (30d)
- 13
Description
Hey folks,
As I mentioned here, Quarto HELP pane does not provide any content (or not the full documentation) in some cases like the one below:
import datar.all as d
import pandas as pd
df = pd.DataFrame({'x':[1,2,4]})
d.glimpse(df)
When I hover on glimpse, I get nothing in Quarto HELP pane.
While, when I do the same thing in a .ipynb file, I get this in the Contextual Help of Jupyter pane:
Bear in mind that I needed to install Jupyter Powertoys due to this issue https://github.com/microsoft/vscode-jupyter/issues/1307#issuecomment-943658044 .
RStudio is so much better in this regard...
Thank you.
Windows 10 pro
Visual Studio Code 1.79.2
python 3.10.4
quarto 1.4.114
Quarto VScode extension v1.88.0
Jupyter PowerToys extension 0.0.8
Contributor guide
No contributing guide indexed for this repository
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 the sample Python hover case in VS Code using the listed Quarto and Jupyter versions, then compare it with contextual help in a .ipynb file. Trace the Quarto HELP pane entry point and determine why content is missing; done means hover documentation appears fully for this case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter, python, vscode
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100