discovery.list_available_checks

discovery.list_available_checks()

List all available checks with their descriptions.

Discovers all registered checks and returns their names and descriptions in a format suitable for display (e.g., in CLI help). Results are sorted alphabetically by check name.

Returns

: list[tuple[str, str]]

A list of (name, description) tuples, sorted alphabetically

: list[tuple[str, str]]

by name. Each tuple contains:

: list[tuple[str, str]]

name: The check’s unique identifier (str)

: list[tuple[str, str]]

description: Human-readable description of what the check does (str)

: list[tuple[str, str]]

If a check’s description cannot be retrieved, “No description

: list[tuple[str, str]]

available” is used as a fallback.

Examples

List all checks for display:

>>> checks = list_available_checks()
>>> len(checks) > 0
True
>>> name, description = checks[0]
>>> isinstance(name, str) and isinstance(description, str)
True

Display in CLI:

>>> for name, desc in list_available_checks():
...     print(f"  {name}: {desc}")
  docs: Check documentation presence
  imports: Check that package imports work
  ...