Code reference information

This section describes how to see definitions of symbols, display documentation references, and use the view parameter information feature.

Parameter info

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 suggestion 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 View | Parameter Info).

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 dialog (Ctrl+Alt+S) , go to Editor | General | Code Completion, and select the Show full method signatures checkbox.

Make sure to include the required third-party JavaScript libraries in the project source path. Otherwise, the names of parameters will not be displayed.

In the Settings dialog (Ctrl+Alt+S) , go to Editor | General | Code Completion.
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

Inlay hints are special markers that appear in the editor and provide you with additional information about your code.

Some of the hints are enabled by default.

You can fine-tune inlay hints in Settings | Editor | Inlay Hints. For detailed explanation of what each type does, refer to Inlay Hints.

Quick Documentation

You can get quick information for any symbol right from the editor with the Quick Documentation feature. It shows you code documentation in a popup as you hover over code elements.

PyCharm recognizes inline documentation created in accordance with PEP-257.

View Quick Documentation in a popup

Hover over the necessary symbol in the editor.
Place the caret at the symbol and press Ctrl+Q (View | Quick Documentation).
Press Ctrl+Q again to open this documentation in the Documentation tool window.

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 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 dialog (Ctrl+Alt+S) , go to Editor | Code Editing | Quick Documentation 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 View | Quick Documentation from the main menu. The documentation will be shown in a popup, but you can configure the IDE to display it in the tool window right away.

Quick Documentation in the tool window

View documentation in the tool window

With the default settings, pressing Ctrl+Q (View | Quick Documentation) 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.

You can view documentation by hovering over code elements.

Click the icon on the tool window toolbar and enable the Show on Mouse Move and Auto-Update from Source options.

You can view documentation as you place the caret at symbols in the editor either by clicking them or by moving the caret.

Click the icon on the toolbar, disable the Show on Mouse Move and enable the Auto-Update from Source options.

You can view documentation by placing the caret at a symbol and pressing Ctrl+Q or selecting View | Quick Documentation from the main menu.

Click the icon on the tool window toolbar, disable the Show on Mouse Move and Auto-Update from Source options.

External documentation

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.

View external documentation

To view documentation for a symbol at the caret in a browser, press Shift+F1 or select View | External Documentation from 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.

Configure External Documentation

In the Settings dialog (Ctrl+Alt+S) open Tools | External Documentation.
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 the Tools | External Documentation dialog 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.

Type Info

In PyCharm, you can identify the type of an expression.

Place the caret at the necessary code element and press Ctrl+Shift+P. Alternatively, select View | Type Info from the main menu.

Productivity tips

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.

Last modified: 22 October 2024