function name + tab does not return docstring in IPython

12,207

Solution 1

Oh, the shortcut is now shift+tab.

Solution 2

Shift-tab only works when you place the edit cursor inside or after the object. Not when it's at the start of the object. This gotcha is not documented anywhere...!

I filed jupyter issue Shift-Tab completion doesn't work when edit cursor is at the start of the object #1902

Solution 3

To display docstrings in Python one can use ? character as a shorthand.

You can place the ? character before or after (no space allowed) the object you are looking for docs.

To access the source code simply use ?? instead.

Source: Help and Documentation in IPython

Share:
12,207
dmvianna
Author by

dmvianna

Former neuroscientist now software engineer.

Updated on June 17, 2022

Comments

  • dmvianna
    dmvianna about 2 years

    In IPython, I am used to write

    function(

    and then strike a tab, and get the contents of the docstring and a list of the named arguments. However, this stopped working since I installed IPython 2.0. Is there an explanation or a know fix?