PyCharm Edu 2019.2 Help

Viewing Inline Documentation

Quick Documentation Lookup helps you get quick information for any symbol or just method signature information, provided that this symbol has been supplied with documentation comments in the applicable format.

The URLs and e-mail addresses specified in the documentation comments for methods are also properly rendered. Clicking a hyperlink opens the corresponding URL in an external browser; clicking an e-mail address opens the default mail client.

When you explicitly invoke code completion, then quick documentation for an entry selected in the suggestion list can be displayed automatically. The behavior of quick documentation lookup is configured in the Show documentation popup in field on the Code Completion page of the Settings/Preferences dialog.

View documentation for a symbol at caret

  • Select View | Quick Documentation Lookup from the main menu.

  • Press Ctrl+Q.

  • Provided that the checkbox Show quick doc on mouse move in the editor settings is selected, just move your mouse pointer over the desired symbol.

Change the font size of quick documentation

  • Click Quick Documentation Settings in the upper-right corner of the quick documentation window, and move the slider.

  • Rotate the mouse wheel while keeping the Ctrl key pressed.

    Note that for this feature to work, you need to enable it in the General page of the editor settings.

    ctrl mouse wheel

    Refer to the section Zooming in the Editor for details.

Documentation window

The Documentation popup helps navigate to the related symbols via hyperlinks, and provides a toolbar for moving back and forth through the already navigated pages, changing font size, and viewing documentation in an external browser.

When pinned, the Documentation popup turns into the Documentation tool window, with the corresponding sidebar icon, and more controls.

To switch between the Documentation popup and the Documentation tool window, use Ctrl+Q.




icons actions back icons actions forward

Left or Right

Switch to the previous or next documentation page (e.g. after using hyperlinks).
icons actions edit F4

Switch to the item (e.g. source) that corresponds to the documentation page currently shown.

Settings Click this icon to perform the following settings:
  • Show the font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.

  • Enable or disable auto-update of documentation from its source.

  • Control the window's position.

Last modified: 22 January 2020