Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I get PyCharm to show method signatures and documentation in the Python/IPython console and the editor?

In IPython's QT console (on Windows 7), if I type:

import scipy scipy.zeros( 

followed by Tab, it displays basic documentation for the method, like its signature, parameters, description, etc. In PyCharm CE 3.4.1, I have IPython enabled as my console, but this doesn't happen. The same is true in the actual editor; if I type this code in the editor, nothing shows up. I don't think this is related to the issue in this question (where PyCharm can't tell the type of something because it's not actually running it) but maybe it is.

like image 555
Michael A Avatar asked Sep 28 '14 17:09

Michael A


People also ask

How do I get function documentation in PyCharm?

PyCharm recognizes inline documentation created in accordance with the JavaScript Documentation Tool format. Press 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.

How do I use IPython display in PyCharm?

Use the magic commands of IPythonFrom the main menu, select Tools | Python Console. If IPython has been properly installed, PyCharm will report about the version used.

How do I see the functions in PyCharm?

In PyCharm, you can see where and how symbols, such as tags, classes, fields, methods, or functions are defined in your project. For this purpose, the IDE features the Quick Definition popup. To view definition of a symbol, select it in the editor and press Ctrl+Shift+I (or click View | Quick Definition).


2 Answers

In pycharm you have ctrl-q (or ctrl-j on a mac) for a quick-doc of the function under the cursor.

like image 56
fricke Avatar answered Sep 26 '22 09:09

fricke


Ctrl + P to show method signature (parameters) as a pop-up.

other shortcut keys for pycharm are all available here.

like image 25
Pedram Avatar answered Sep 24 '22 09:09

Pedram