get_description

get_description(prefix: str, *, use_markdown: bool = False) str | None[source]

Get the description for the given prefix, if available.

Parameters:
  • prefix – The prefix to lookup.

  • use_markdown – Should markupsafe and markdown wrap the description string

Returns:

The description, if available.