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

Navigation Bar - All the power!
Navigation Bar - All the power!
The Navigation Bar can do much more than you think!
Clean Up Messy Imports With Optimize Imports
Clean Up Messy Imports With Optimize Imports
Quickly remove any unused imports and more.
Find in Path with the Navigation Bar
Find in Path with the Navigation Bar
Use the Navigation bar and Find in File together and be faster than all of your team members.