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
Tooltip doesn't show constructor docstrings #1094
Comments
@bfroehle @fperez sayed :
So we might also want to append the differents |
For symmetry with qtconsole, etc, I guess we should reimplement |
In the Qtconsole we do NOT show both docstrings, only the one with the highest priority:
|
As mentioned when closing #1096, eventually a nice refactoring of these tools for better reuse and uniformity in output is needed. |
Show constructor docstrings in notebook tooltip. Closes ipython#1094.
Hey @Carreau, try this one in a notebook:
You get a 'no docstring', while doing
Image?
works. The reason is that in?
, we check if the object has no docstring but is a class, and in that case we display its constructor docstring, which is typically the most useful one. In fact, for classes that have both, we show both. Futhermore, for classes the signature that matters is the constructor one, since that's what people will actually be calling:Ideally, the tooltip would have the same semantics (not show the rest of what ? shows, but do the same regarding docstrings and call signatures).
I don't know how much time you have over the next few days (and you've already done great work!) but it would be great to ship the notebook with this in really solid shape.
The text was updated successfully, but these errors were encountered: