-
Notifications
You must be signed in to change notification settings - Fork 676
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
Improve the display of docstrings #758
Comments
We should be able to display more content now, since the bug that used to be in VS limiting the height of the tooltip is fixed. Colours in tooltips is a big risk, as the tooltips are themed, but if we can find an easy way to tie them to the editor colours when we generate the XAML for them we should be okay. What might be easier is having an object browser for our analysed results that F12 (or maybe we steal F1?) can open - more like how Jupyter does its #235 and #773 will also help display more accurate information in completion lists. |
+1, and scrollable tooltip docstring information |
Scrollable would be amazing, but I don't think it's technically feasible due to the way those tooltips are implemented. (Though I heard there were some changed made for VS 2015, so that may no longer be the case. Fairly sure it still can't get though focus, which makes scrolling impossible.) |
I agree with @crwilcox. I'm used to Spyder and Ctrl+I to see the whole documentation for Numpy, Scikit-learn and the likes is one feature I'm missing in PTVS. I also think a dedicated window to browse the documentation would be the way better than tooltips for two reasons:
Here is how Spyder does it: https://pythonhosted.org/spyder/inspector.html |
In a recent post to HN about PTVS we received feedback that our documentation could be much easier to read. The thought here is to provide a better format, more full documentation experience for our users.
#235 captures the improvements to parsing to bring in missing docstrings.
This issue captures displaying those docstrings better.
Particularly there are two things to be addressed here
The success of this work item will depend on the implementation of #235 to some extent as it will assist in completing item number 1.
Here is what we display for this method. Below it is the full docstring. We need to display more of this. (Item 1)
Here is an image of the Documentaion Display brought up by 'ctrl+space' currently
We could add color or boldness, format better, etc.
A sort of thought on the above is making it look like the following:
Or with color as well for certain '' and ' fields
Inspiration from HN Comments: (https://news.ycombinator.com/item?id=9998227, user saboot)
The text was updated successfully, but these errors were encountered: