Code reference information
This section describes how to see definitions of symbols, display documentation references, and use the view parameter information feature.
The Parameter Info popup shows the names of parameters in method and function calls. PyCharm automatically shows a popup with all available method signatures within 1 second (1000 milliseconds) after you type an opening bracket in the editor, or select a method from the suggestions list.
You can explicitly invoke the popup if it has closed or if your IDE is configured not to show the popup automatically. To do so, press Ctrl+P (or click ).
Show full method or function signatures
By default, the parameter info popup shows simple signatures. You can configure the IDE to show full signatures that include method names and returned types.
In the Settings/Preferences dialog (Ctrl+Alt+S), go to , and select the Show full method signatures checkbox.
Configure the parameter info popup
In the Settings/Preferences dialog (Ctrl+Alt+S), go to .
In the Show the parameter info popup in ... milliseconds field, specify the time in milliseconds after which the popup should appear.
If you don't want the popup to appear automatically, clear the Show the parameter info popup in ... milliseconds checkbox.
Inlay hints are special markers that appear in the editor and provide you with additional information about your code, like the names of the parameters that a called method expects. Other types of hints inform you about annotations, method parameters, usages, and so on (depending on the language).
Some of the hints are enabled by default.
You can fine-tune inlay hints in Inlay Hints.. For detailed explanation of what each type does, see
Configure the parameter hints exception list
If you don't want to see parameter hints for specific methods, you can configure the list with exceptions. By default, the exception list contains a number of pre-defined methods. You can remove a method from the list to see the hints for it, or add new methods to hide their hints in the editor.
In the Settings/Preferences dialog (Ctrl+Alt+S), select and click the necessary language.
Select Parameter hints in the list in the middle section.
The options for configuring hints become available on the right.
Add methods for which you don't want to see the hints to the Exclude list section.
Add cases for which you do not want to see the hints to the Exclude list section. To add a case, click the inline hint in your code, press Alt+Enter and select Do not show hints for current method.
Apply the changes and close the dialog.
You can get quick information for any symbol right from the editor by means of the Quick Documentation feature. It shows you code documentation in a popup as you hover the mouse over code elements.
PyCharm recognizes inline documentation created in accordance with PEP-257.
Quick Documentation in a popup
View Quick Documentation in a popup
Hover the mouse over the necessary symbol in the editor.
Place the caret at the symbol and press Ctrl+Q ().
Press Ctrl+Q again to open this documentation in the Documentation tool window.
Click links in the documentation topic to preview documentation for top-level elements (in this example: math) or to the related types (in this example: float).
Click in the popup to change the font size, display the quick documentation toolbar, or go to the source code.
Disable Quick Documentation on hover
By default, the quick documentation popup appears as you hover the mouse over code elements. You can configure the IDE to display the popup only after you explicitly invoke the Quick Documentation feature.
Click in the popup and disable the Show on Mouse Move option.
In the Settings/Preferences dialog (Ctrl+Alt+S), go to and clear the Show quick documentation on hover checkbox.
In this case, to view documentation for a symbol at caret, press Ctrl+Q or select display it in the tool window right away.from the main menu. The documentation will be shown in a popup, but you can configure the IDE to
Quick Documentation in the tool window
View documentation in the tool window
With the default settings, pressing Ctrl+Q () opens quick documentation in a popup. You can change the settings to view documentation in the tool window.
In the quick documentation popup, click and disable the Show Documentation Popup First option.
In the Documentation tool window, click the icon on the tool window toolbar and disable the Show Documentation Popup First option.
Keep documentation in the tool window
You can open a piece of documentation for a specific code element in the tool window and keep viewing documentation for other elements in your current file.
Place the caret at the required code element and press Ctrl+Q. If the popup appears, press Ctrl+Q again to switch to the tool window.
The asterisk symbol (
*) on the documentation tab means that the tab is not pinned, so its content will be replaced by documentation for another code element that you select in the editor.
Right-click the tab with the documentation in the documentation tool window and enable the Keep This Documentation option.
After that, the current documentation tab will be pinned. You can return to the editor and view documentation for other code elements that will open either in the popup or in a new tab in the tool window.
External documentation opens the necessary information in a web browser so that you can navigate to related symbols and keep the information for further reference at the same time.
PyCharm shows documentation for SciPy, NumPy, PyGTK, and the other modules you've installed for your Python interpreter. External documentation should be properly configured in the External Documentation page of the Settings/Preferences.
View external documentation
To view documentation for a symbol at the caret in a browser, press Shift+F1 or selectfrom the main menu.
To view external documentation, you need to configure the documentation URL first. PyCharm comes with the URLs for pandas, wx, kivy, PySide, PyQt5, PyQt4, matplotlib, pyramid, flask, and gtk. You can modify the predefined set of URLs or add a new one in the project Settings/Preferences.
Configure External Documentation
In the Settings/Preferences dialog (Ctrl+Alt+S) open .
To add a new documentation URL, click . In the opened dialog, specify the module name and the URL of the corresponding external documentation.
If external documentation resides locally, specify the local path to it.
To modify any of the preconfigured documentation URLs, select the documentation module in thedialog and double-click it or click .
To set up a URL pattern, select a macros in the Available Macros field and click the Insert button.
Note that each documentation module has its specific structure, so be careful when adding macros.
In PyCharm, you can identify the type of an expression in the following way:
Place the caret at the necessary code element and press Ctrl+Shift+P (or selectfrom the main menu).
- Copy tooltip text to the clipboard
To copy tooltip text to the clipboard, hold Alt (on Linux, hold Ctrl+Alt) and click the tooltip.
- View context information
If the current method or class declaration is not visible, you can view it in the tooltip by pressing Alt+Q.