In IPython, you can use ? or ?? to display information about the object like the docstring, signature and type:
In [2]: print??
Docstring:
print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
Prints the values to a stream, or to sys.stdout by default.
Optional keyword arguments:
file: a file-like object (stream); defaults to the current sys.stdout.
sep: string inserted between values, default a space.
end: string appended after the last value, default a newline.
flush: whether to forcibly flush the stream.
Type: builtin_function_or_method
However, in Jupyter this information is rendered in a box at the bottom instead of bellow the code cell.
This means code like this:
.. jupyter-execute::
print??
Will not render any output in the documentation.
Is this expected? Would it make sense to implement support for showing this type of information bellow the code cell in the documentation?
In IPython, you can use
?
or??
to display information about the object like the docstring, signature and type:However, in Jupyter this information is rendered in a box at the bottom instead of bellow the code cell.
This means code like this:
Will not render any output in the documentation.
Is this expected? Would it make sense to implement support for showing this type of information bellow the code cell in the documentation?