Jump to content

Jupyter Docstring Shortcut


Emily Johnston
 Share

Recommended Posts

  • Seeq Team

Sometimes users want to find more documentation on the SPy functions than what is provided in the SPy Documentation Notebooks. A quick way to access SPy object documentation from your notebook is by using the Shift + Tab shortcut to access the docstring documentation of the function.

  • Example view of the docstrings after using the Shift + Tab shortcut:

 image.png

You can expand the docstrings to view more details by clicking the button circled in red in the above image.

  • Expanded docstrings:

image.png

From here, you can scroll through the documentation in the pop-up window.

Another useful shortcut is the Tab shortcut. This will show a list of available functions or methods for either the SPy module or any other python object you have in memory.

  • Example view of the Tab shortcut:

image.png

  • Like 4
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

×
×
  • Create New...