PyCharm 2016.3 Help

TODO Tool Window

View | Tool Windows | TODO

PyCharm scans your project for comments in the source code that match the TODO patterns defined in the TODO dialog and displays results in the TODO tool window.

The TODO tool window is marked with the icon /help/img/idea/2016.3/icon_todo.png and consists of the following tabs:

  • Project tab that show the TODO items for the whole project.
  • Current File tab.
  • Scope Based tab that enables viewing TODO items pertaining to a certain scope, selected from the drop-down list, and ignoring the other items.
  • Current Changelist, if version control is enabled.

This tool window helps you view, sort and group the TODO items in a convenient way, navigate to the source code and keep fixes under the version control.

On this page:

Toolbar buttons

ItemTooltip and shortcutDescription
arrowUp Previous TODO
Navigate to the previous TODO item.
arrowDown Next TODO
Navigate to the next TODO item.
help Help
Use this icon or shortcut to open the corresponding help page.
Expand all
Ctrl+NumPad Plus
Collapse all
Ctrl+NumPad -
Use these buttons to have all nodes expanded or collapsed.
img Autoscroll to SourceToggle the Autoscroll to source mode. When this button is pressed, every time the node is focused, the corresponding line of source code is highlighted in the editor.
commonfilter Filter TODO itemsClick this button to select the desired filter from the list, or invoke the TODO dialog and edit the list of TODO patterns and filters as required.
previewUsages Preview UsagesIf this button is pressed, a pane to the right shows the source code of the selected file, with the corresponding TODO item highlighted.
img Ctrl+D If this button is pressed, the TODO items show under the corresponding module or library node.
img Ctrl+P If this button is pressed, the TODO items show under the corresponding packages.
img Ctrl+F If this button is pressed, the TODO items show as a flat list. Thus, if a package is somewhere deep within your project, you do not need to dig deep into the hierarchy.

Context menu commands

ItemKeyboard ShortcutDescription
Jump to Source F4 Navigate to the selected usage in the source code.
Local HistoryShow Local History submenu for the selected search result. Refer to the Local Version Control procedures for details.
<VCS>Show menu of the VCS, associated with the directory. See Version Control Procedures and Reference for details.

Title bar context menu and buttons

The title bar context menu provides the options for controlling the tool window viewing modes. It also contains the commands for associating the tool window with a different tool window bar, resizing and hiding the tool window.

To access the menu, right-click the window title bar.

Note that most of the menu options may alternatively be accessed by means of the title bar buttons.

Toolbar iconContext menu commandDescription
/help/img/idea/2016.3/viewMode.png Pinned, Docked, Floating, Split ModeThese options let you control general appearance and behavior of the tool window, see Viewing Modes.
Move toTo associate the tool window with a different tool window bar, select this command, and then select the destination tool window bar (Top, Left, Bottom or Right).
ResizeTo resize the tool window by moving one of its borders, select this command, and then select the necessary Stretch to option.

Note that this command is not available in the floating mode.

HideUse this command to hide the tool window.

See Also

Last modified: 23 December 2016