Source Assistant Options

Index of All Documentation » Wing Pro Reference Manual » Source Code Editor » Source Assistant »

There are several options available to control docstring rendering. These accessed by right clicking on the Source Assistant:

Use PEP 287 docstrings -- By default Wing tries to render docstrings by treating them as PEP 287 reStructuredText Docstring Format. This option can be used to disable PEP 287 rendering so they are always shown as plain text instead.

Show PEP 287 parse errors -- When this option is disabled, the focus is on showing as much information as possible and not on diagnosing docstring formatting errors. Wing will try to display docstrings as rendered reStructuredText even if they contain parse errors. Wing uses a set of heuristics to gloss over common errors so the docstring can be rendered, or in more severe cases, Wing falls back to showing the docstring as plain text. When this option is enabled, Wing will shift its focus to reporting PEP 287 parse errors that equal or exceed the PEP 287 parse error threshold in severity. Errors are shown in the context of its reStructuredText rendering of the docstring.

PEP 287 parse error threshold -- This sets the error level at or above which Wing will determine that parsing the PEP 287 docstring has failed. When below this level, a best effort will be made to render the docstring without showing any errors. When above this level, Wing either shows the parse errors in the rendered docstring (if Show PEP 287 parse errors is enabled) or falls back to showing the docstring in plain text. The default is to treat warnings, errors, and severe errors as parse errors.

Show docstring type and validity -- This enables or disables the floating docstring type and validity indicator in the top right of the docstring area.

Rewrap plain text docstrings -- By default Wing employs a heuristic to rewrap paragraphs in docstrings, in order to make better use of available display space. This option can be disabled to show the docstring exactly as it appears in the source code.

Always show docstrings -- By default Wing shows the docstring only of the last symbol being displayed in the Source Assistant, in order to save on display space. Enable this option to always show the docstring for all symbols.

The Source Assistant context menu can also be used to copy text or HTML to the clipboard, change the display font size, and access this documentation.