Quick Documentation

View arguments and documentation without interrupting your flow.

We frequently encounter code that we're not sure about. Other people's code. Heck, even our code. Sometimes we just want the arguments for a function. Other times we want to know positional versus keyword args. Or the types of the arguments. Or their default values. Or a nice rendered docstring.

PyCharm has several facilities for showing you documentation about a symbol.

First, Quick Documentation F1 (macOS) / Ctrl+Q (Windows/Linux) brings non-obtrusive inline popup showing all that information, with a hyperlink where you can navigate to the definition. Press it again and the popup turns into a tool window which updates for each symbol that you land on. Always there, always helping...until you want to hide it, like any other IDE tool window.

Want the full docs in a browser, but don't want to hunt around to find it? For many popular packages, External Documentation ⇧F1 (macOS) / Shift+F1 (Windows/Linux) brings up a browser on the documentation page for that symbol.

Related Resources

See VCS Changed Lines In Gutter
Quickly spot which parts of your file have changed since the last commit.
Autocomplete Django Settings Strings
Use autocomplete when typing a string in the apps section of your settings file.
Split Screen Without Tabs
Get your code and tests side-by-side without resorting to tabs.