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

added default text to inspector module #6476

Merged
merged 1 commit into from Jun 6, 2019

Conversation

@ibdafna
Copy link
Member

@ibdafna ibdafna commented Jun 5, 2019

References

This pull request addresses one of the issues raised in #2398, where users who open the Inspector see a blank window without any indication as to what it is supposed to show, often leading them to think it is broken.

Code changes

With the help of @jasongrout and @ivanov, we modified the inspector.ts file to implement the following logic:

  1. Upon instantiation, the Inspector module will render with a default text indicating what the user should do in order to get docstrings to display.
  2. When a user clicks on/types a defined function in any cell, that function's docstring will be displayed in the Inspector window.
  3. When the user navigates away from the function or clicks on any other element which is not a defined function and has no docstring, the Inspector window will simply keep the old docstring on the screen until a new docstring from another function is fed in.

User-facing changes

The Inspector window will now always have some content displayed, whereas before, upon instantiation, it was blank. In addition, when a user navigated away from a defined function into an empty cell, the Inspector window would clear.

Before

inspector_before

After

inspector_after

Backwards-incompatible changes

None that I can see.

@jupyterlab-dev-mode
Copy link

@jupyterlab-dev-mode jupyterlab-dev-mode bot commented Jun 5, 2019

Thanks for making a pull request to JupyterLab!

To try out this branch on binder, follow this link: Binder

@jasongrout
Copy link
Contributor

@jasongrout jasongrout commented Jun 6, 2019

Great, thanks! The test failure looks very unrelated.

@jasongrout jasongrout merged commit eedff54 into jupyterlab:master Jun 6, 2019
7 of 9 checks passed
@jasongrout jasongrout mentioned this pull request Jun 6, 2019
@saulshanabrook saulshanabrook added this to the 1.0 milestone Jun 17, 2019
@lock
Copy link

@lock 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
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants