PyCharm 2021.1 Help

Reader mode

Use this page to configure how to display code and comments in read-only files and libraries to make them easier to read and understand. For example, you can enable inlay hints, font ligatures, adjust line height, and so on.

ItemDescription
Enable Reader mode

Use this checkbox to enable or disable the option.

Use the following options to configure how and what should be displayed in the reader mode:

  • Rendered documentation comments: select this option to see the comments as a regular text while reading a read-only file. You can always change the rendered view while in the editor. Click Toggle rendered view in the gutter or press Ctrl+Alt+Q.

  • Editor breadcrumbs: select this option if you want to see breadcrumbs in the editor when you jump from one code item to another.

  • Error and warning highlighting, inspection widget: select this option if you want the editor to indicate that you are viewing the file in the reader mode. PyCharm also keeps track of found errors and warnings and displays them accordingly. For example, if you install a package in the terminal using the pip install command, you can clear this option and suppress error highlighting for the package to easily review its code.

    Reader Mode: Suppressing error message in a package

  • Font ligatures: select this option if you want to see the code in the read-only file with ligatures.

  • Increased line height: select this option to see the increased line spacing in the file for better reading.

  • Code vision hints for usages, inheritors, and related problems: select this option to see the inline hint in the code you are reading.

Last modified: 06 April 2021