Before you start
Make sure that:
- You are working with PyCharm version 2.7 or higher
- You are familiar with the product documentation on the matter.
- You have created a project and added some script. You can take a project and a script from the tutorial Getting Started.
Viewing quick definition
Quick definition is useful when you want to just view the definition info, without actually jumping to the location where a symbol is defined. For example, place the caret at the exception, and choose View→Quick Definition on the main menu:
You can follow links in the quick definition pop-up window, and then navigate back and forth using the arrow keys or left and right arrow icons.
Clicking the pin button opens the quick definition in the Find tool window:
Viewing quick documentation
Quick documentation shows the existing documentation and signature of a symbol. Again, place the caret at the exception, and this time choose View→Quick Documentation on the main menu:
Note that you can follow links in the quick documentation pop-up window, and then navigate back and forth using the arrow keys or left and right arrow icons:
It's possible to change font size in the quick documentation pop-up window. To do that, click the cog icon to reveal the font size slider. Move the slider to change font size:
Clicking the pin button opens the quick documentation in the Documentation tool window
To restore quick documentation pop-up window, click .
Viewing external documentation
This command allows viewing detailed documentation in the default system browser:
By the way, you can open the external documentation from the quick documentation pop-up window - just click up arrow , or press the keyboard shortcut (Shift+F1)
External documentatin works by default for Python, PyQt4, PySide, gtk, wx, numpy, scipy, and kivy. However, if you want to view documentation for some other packages, for example, Pyramid, you have to specify it in the page Python External Documentation.
Viewing parameter information
This command shows the parameter information for a function or method:
Viewing context information
Finally, you can view in a pop-up window the beginning of the code block, where a certain symbol belongs. For example, place the caret at the exception, when the method declaration is out of the view, and press Alt+Q, or choose View→Context Info: