Menu
I would like to know how to configure PyCharm so that when I hover over an object or method I get a (formatted) pop-up containing the doc-string. How can I do this?
240
Quick documentation look-upPress Ctrl+Q or choose View | Quick Documentation Lookup on the main menu. In the Settings/Preferences dialog ( Ctrl+Alt+S ), go to Editor | General | Code Completion. The Code completion page opens.
Press Ctrl+Alt+S and go to Editor | General |Smart Keys. Select the Insert type placeholders checkbox in the Smart Keys page of the editor settings. Place the caret at the function name, and press Alt+Enter . In the list of intention actions that opens, choose Insert documentation string stub.
Place the caret somewhere within the function you want to document. Press Alt+Enter to show the available intention actions. PyCharm generates documentation comment stub according to docstring format, selected in the Python Integrated Tools page.
Press Ctrl+Alt+S to open the IDE settings and select Editor | General | Code Completion. The suggestion list will look as follows with the icons marking reordered and the most relevant items.
Original feature request ticket: http://youtrack.jetbrains.com/issue/IDEA-66333
If PyCharm you are using is on 131.xxx branch or newer (can be found on "Help | About") then such option is available under Settings/Preferences | Editor | General | Show quick doc on mouse move.
For some earlier builds (when GUI controls where not yet available) it was possible to activate it by adding auto.show.quick.doc=true into IDE_INSTALL_FOLDER/bin/idea.properties file.
Modern IDE versions have it at Settings/Preferences | Editor | Code Editing | Show quick documentation on mouse move and it is enabled by default:
(The screenshot is from PhpStorm but the option name & path is the same across IDEA-based IDEs)
104
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
