question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

One of the great benefits of python notebook is the exploratory nature of it. I personally find the contextual help window in jupyter lab a very helpful feature that makes the exploratory data analysis very easy by providing a fluid guide for the many API’s that one might have to try. I don’t know how big of an ask this is, but it would be much appreciated to provide this in VScode notebook editor.

Below is a screen shot of what I am referring to in jupyter lab. The functionality is that by clicking on each function, the docstring for that function is show in the contextual help window.

image

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:74
  • Comments:57 (15 by maintainers)

github_iconTop GitHub Comments

29reactions
allefeldcommented, Jul 21, 2020

I would like to strongly support this!

I have been switching between Python IDEs on a search for the best, and have now arrived at VS Code which in my experience is superior in many ways.

But one feature I really miss from Jupyter Lab is the automatically updated contextual help panel.

As I wrote in issue microsoft/vscode-python#11655 linked to above, the current pop-up crushes everything together, is too small to read long texts, and disappears too easily on mouse movement. It is also often hard to trigger.

Yes, it is possible to use the IPython-style ?, but that means to open a new cell, type in the command, then scroll through a small viewport. For many packages, documentation can be many pages long, I think that deserves a dedicated panel.

20reactions
javierbqcommented, May 9, 2020

@rchiodo not the same, Jupiter’s automatic contextual help is just amazing.

Being able to see the state of variables and documentation just by clicking on a cell is just great. Huge productivity boost.

Read more comments on GitHub >

github_iconTop Results From Across the Web

What is Contextual Help, and how it can lead to happier users
Contextual help makes your software easier to use and is the least demanding way to offer user support. What's known as context switching...
Read more >
UX/ UI tips: A guide to contextual help | by Sarah Edwards
Contextual help, also known as context-sensitive help, provides support for the user relative to the area they are currently interacting ...
Read more >
What Is Contextual Help? The Key to Happy Customers - Whatfix
For website/web-app users, contextual help or context-sensitive help is a simple method of getting their queries resolved promptly. While using ...
Read more >
Contextual help - Adobe Spectrum
Contextual help describes a larger experience, such as something that's associated with that element in a broader sense. Use contextual help to communicate ......
Read more >
Introduction to Contextual Help - ProProfs Knowledgebase FAQs
Contextual help is integrated assistance to your help site, making an easy-to-read experience for your Knowledge Base. It guides users on what a...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found