The documentation text made safe for any Markdown renderer (see the module docstring). Fenced code blocks (a line of three or more backticks or tildes opens one, a line of at least as many of the same character closes it, an unclosed fence runs to the end) are returned unchanged; so are unambiguous inline code spans (_escape_line).

Methods

escape_markdown_prose

escape_markdown_prose(text: str) -> str

The documentation text made safe for any Markdown renderer (see the module docstring). Fenced code blocks (a line of three or more backticks or tildes opens one, a line of at least as many of the same character closes it, an unclosed fence runs to the end) are returned unchanged; so are unambiguous inline code spans (_escape_line).

ParameterTypeDescription
textstr

Generated with Flude

Copyright © 2026