PyCharm 3.4.0 Web Help

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.

PyCharm recognizes inline documentation created in accordance with the docstring format.

Such documentation is rendered in the Documentation Tool Window according to the docstring format, selected in the Python Integrated Tools page.

Note

For information on retrieving inline documentation in the JavaScript context, refer to section Viewing JSDoc Comments.

In this section:

To view documentation for a symbol at caret, do one of the following
  • On the main menu, choose View | Quick Documentation Lookup.
  • Press Ctrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+QCtrl+Q or Alt+Button2 ClickAlt+Button2 Click, Ctrl+Shift+Space or F2F1, Control J or Control Button2 ClickControl J or Control Button2 ClickAlt Button2 Click or F2.
  • 3.4+
    Provided that the check box Show quick doc on mouse move in the editor settings is selected, just move your mouse pointer over the desired symbol.

Note

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 Code Completion page of the Settings dialog.

To change the font size of quick documentation, do one of the following
  • Click show-slider in the upper-right corner of the quick documentation window, and move the slider.
  • Rotate the mouse wheel while keeping the Ctrl key pressed.

Toolbar of the Quick Documentation Lookup

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

2.6+

When pinned, the Quick Documentation Lookup turns into Documentation Tool Window, with the corresponding sidebar icon, and more controls.

Icon Keyboard shortcut Action
arrowBack arrowForward Shift+Alt+LeftShift+Alt+LeftShift+Alt+LeftShift+Alt+LeftShift+Alt+LeftShift+Alt+LeftCtrl+Alt+Page UpCtrl+Shift+Alt+RightControl Shift LeftControl Shift LeftControl Shift Left or Shift+Alt+RightShift+Alt+RightShift+Alt+RightShift+Alt+RightShift+Alt+RightShift+Alt+RightCtrl+Alt+Page DownCtrl+Shift+Alt+LeftControl Shift RightControl Shift RightControl Shift Right Navigate to the previous or next screen after using hyperlinks in the definition.

Note

On a OS X computer, you can also use the three-finger right-to-left and left-to-right swipe gestures.

arrowUp.png Shift+F1Shift+F1Shift+F1Shift+F1Shift+F1Shift+F1 or Ctrl+F1Shift+F1Shift+F2Shift F1Shift F1Shift F2 View external documentation in the default browser.
show-slider Click this button to show font size slider. Move the slider to increase or decrease the font size in the quick documentation window as required.

Tips and tricks

  • Sequential pressing Ctrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+Q or Alt+Button2 ClickCtrl+QCtrl+Q or Alt+Button2 ClickAlt+Button2 Click, Ctrl+Shift+Space or F2F1, Control J or Control Button2 ClickControl J or Control Button2 ClickAlt Button2 Click or F2 toggles the focus of the Quick Documentation pop-up window and Documentation Tool Window.

See Also

Procedures:

Reference:

External Links:

Web Resources: