Docstring Type and Validity

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


By default the Source Assistant displays a type and validity indicator for docstrings, showing whether the docstring was successfully parsed or reformatted. The following messages may be displayed:

✔ PEP287 -- The docstring parses successfully using PEP 287 reStructuredText Docstring Format and is being rendered accordingly. This only occurs when the Use PEP 287 for docstrings option is enabled and the docstring parses without errors that equal or exceed the configured PEP 287 parse error threshold.

✖ PEP287 -- The docstring does not parse successfully as reStructuredText and is showing inline parse errors. This only occurs when the Show PEP 287 parse errors option is enabled.

Rewrapped -- The docstring is being shown as plain text but Wing has heuristically rewrapped paragraphs. This only occurs when the Rewrap plain text docstrings option is enabled.

Plain Text -- The docstring is being shown as plain text, exactly as it appears in the source code. PEP 287 style docstrings may fall back to plain text if they cannot be parsed and the Show PEP 287 parse errors option is disabled.

See Source Assistant Options for a list of the available display options.