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

Add VS Code How To Guide #5196

Merged
merged 16 commits into from
Jul 24, 2023
Merged

Add VS Code How To Guide #5196

merged 16 commits into from
Jul 24, 2023

Conversation

MarcSkovMadsen
Copy link
Collaborator

@MarcSkovMadsen MarcSkovMadsen commented Jul 1, 2023

Partly Adresses #2833

By accident builds on top of #5112 (load.md file). I don't know how to remove that.

Preview: vscode_configure.md, editor_debug.md, editor.md,

Todo

  • Write proposal
  • Split into more dedicated guies
  • Get review
  • Finalize

Maybe later

  • how to use Panel with VS Code dark themes in notebook environment.
  • how to debug bound Panel callbacks in notebook environment
  • Figure out how to add keyboard shortcut to open https://panel.holoviz.org. I could not figure it out.
  • Create really big and useful snippets file instead of just a few examples.
  • Add similar guide(s) for PyCharm.

Issues identified

  • Panel not working with dark theme in notebook environment (or at least I could not figure out get something readable)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I could not get this working with dark theme. The text in the output cells is not readable.

@codecov
Copy link

codecov bot commented Jul 1, 2023

Codecov Report

Merging #5196 (de23b8d) into main (99ad77f) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #5196      +/-   ##
==========================================
- Coverage   83.80%   83.79%   -0.01%     
==========================================
  Files         274      274              
  Lines       39649    39649              
==========================================
- Hits        33226    33224       -2     
- Misses       6423     6425       +2     
Flag Coverage Δ
ui-tests 40.56% <ø> (-0.02%) ⬇️
unitexamples-tests 73.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

"panel",
"serve",
"${relativeFile}",
"--show"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Maybe we should add --autoreload also. But I have no experience telling me if this is a good idea or not.

@MarcSkovMadsen MarcSkovMadsen marked this pull request as ready for review July 1, 2023 16:11
@MarcSkovMadsen
Copy link
Collaborator Author

I've split refactored such that the material is split into

  • The existing editor.md guide
  • A new editor_debug.md guide
  • A new vscode_configure guide.

To me that makes sense. Let me know what you think @philippjfr . Thanks.

@MarcSkovMadsen
Copy link
Collaborator Author

This one is ready for review. Don't plan to do more before the review.

Copy link
Member

@philippjfr philippjfr left a comment

Choose a reason for hiding this comment

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

Thanks, this is already looking good. We can always tweak more later but we might as well get this into 1.2.1.

@philippjfr philippjfr merged commit a995981 into main Jul 24, 2023
9 of 14 checks passed
@philippjfr philippjfr deleted the enhancement/vs-code-docs branch July 24, 2023 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants