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

is there documentation? #162

Closed
pelikhan opened this issue Apr 3, 2023 · 9 comments · Fixed by #182
Closed

is there documentation? #162

pelikhan opened this issue Apr 3, 2023 · 9 comments · Fixed by #182
Assignees
Labels
question Further information is requested

Comments

@pelikhan
Copy link
Member

pelikhan commented Apr 3, 2023

No description provided.

@DonJayamanne
Copy link
Contributor

Thanks for filing this issue, not sure what you mean by documentation
This extension is used to render outputs for Jupyter Notebooks in VS Code
Uses the VS Code API to contribute renderers for different mime types

Perhaps you are running into some issue hence looking for some documentation
Pelase could you describe the reason why you are looking for documentation, is it to contribute or to figure out what this extension does (perhaps you are new to Jupyter Notebooks or the like)

@DonJayamanne DonJayamanne self-assigned this Apr 3, 2023
@DonJayamanne DonJayamanne added the question Further information is requested label Apr 3, 2023
@pelikhan
Copy link
Member Author

pelikhan commented Apr 4, 2023

Which renderer are you adding? How do we use this in a notebook?

@DonJayamanne
Copy link
Contributor

DonJayamanne commented Apr 4, 2023

You do not need to do anyting specific to use renderers in a notebook.
If you run a cell in Jupyter and you get output such as text/html, then vscode will select a text/html rendere and display that.
This extension supports renderers for gif, png, jpg, svg, vega, plotly and other mime types.
Png, svg renderers are already supported in vscode, however jupyter ntoebooks might require addtional changes, hence the custom renderers

How do we use this in a notebook?

Just install this and outputs in notebooks would be displayed. E.g. if you have a notebook with plotly/vega output, this renderer would handle that and display the rich output, and without this extension you would just get some plain text.
If you expect to see a specific type of output or format, and it does not work as expected, then i would expect users to file an issue

You would need this extension when working with Jupyter notebooks in VS Code

@DonJayamanne
Copy link
Contributor

Which renderer are you adding?

Will update the REDME to document this.

@iamhammer
Copy link

Is there a way to render SQL Output (or CSV) in a grid view?

@DonJayamanne
Copy link
Contributor

Is there a way to render SQL Output (or CSV) in a grid view?

Unfortunately no, you might want to look for other VS Code extensions or jupyter notebook magics or packages that make this possible.

@ToON-01
Copy link

ToON-01 commented Jun 16, 2023

oidkksjyeootiugkopuflskks;;

@ToON-01
Copy link

ToON-01 commented Jun 16, 2023

kkoiuyfpiuelsbbioeus
@dnfclas slall

@ToON-01
Copy link

ToON-01 commented Jun 16, 2023

uuuuuuuu

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants