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

inspector updates #2398

Closed
akhmerov opened this issue Jun 7, 2017 · 8 comments
Closed

inspector updates #2398

akhmerov opened this issue Jun 7, 2017 · 8 comments
Labels
enhancement good first issue pkg:inspector status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. tag:Design and UX
Milestone

Comments

@akhmerov
Copy link
Member

akhmerov commented Jun 7, 2017

I've just discovered the inspector, and I found it super cool! I have two remarks for your consideration:

  • When it is initially opened, it's completely blank and non-interactive, and it took me some time to figure out how to use it. Perhaps use the time when it's blank to show a brief hint describing what it should do.
  • As far as I could tell, inspector is only updated on key press events. This may be inferior to updating it whenever user moves the cursor. Alternatively one could reuse the shortcut for firing up the inspector also for refreshing its state. Or yet another option would be to invoke/update the inspector upon consecutive pressed of shift-tab, similar to the classic notebook.
@AbdealiLoKo
Copy link
Member

Noob question: how do I get it to work? I do that know what to do with the blank screen :|

@blink1073
Copy link
Member

It responds to typing in a cell and shows the documentation automatically.

Type print( and it will show the docstring.

@akhmerov
Copy link
Member Author

akhmerov commented Jun 8, 2017

Hehe, @AbdealiJK I had exactly the same problem. That's why I suggested to make the default status not blank. I even checked developer console and updated jlab because the inspector looked like it was missing.

@giladgressel
Copy link

Just gonna chime in that I literally spent like 10 minutes searching the docs trying to understand what it did. Finally just googled and got here.
It's pretty cool. Does what shift-tab x4 does from reg notebook.

@jasongrout jasongrout removed this from the 1.0 milestone Sep 5, 2018
@jasongrout
Copy link
Contributor

Definitely +1 to some help text when it initially opens.

@jasongrout jasongrout added this to the Future milestone Sep 7, 2018
@jasongrout
Copy link
Contributor

Adding "good first issue" - the initial help page should be pretty straightforward to add. The inspector panel is at https://github.com/jupyterlab/jupyterlab/blob/master/packages/inspector/src/inspector.ts. Perhaps a constructor argument should take some initial help text?

@jasongrout
Copy link
Contributor

Fixed by #6476 (and someone else fixed it so that it responded to cursor movements, not just keyboard movements).

@jasongrout jasongrout modified the milestones: Future, 1.0 Jun 6, 2019
@lock
Copy link

lock bot commented Aug 6, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related discussion.

@lock lock bot locked as resolved and limited conversation to collaborators Aug 6, 2019
@jasongrout jasongrout added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Aug 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement good first issue pkg:inspector status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. tag:Design and UX
Projects
None yet
Development

No branches or pull requests

6 participants