Skip to main content

Module error_hints

Module error_hints 

Source
Expand description

Error hints: mapping from error variants to user-facing remediation suggestions.

Each error variant maps to:

  • A 1-line summary (human readable)
  • 0-2 actionable hints (commands, env vars, paths)
  • Contextual fields that should be printed with the error

§Design Principles

  • Hints must be stable for testability
  • Avoid OS-specific hints unless OS is reliably detectable
  • Never suggest destructive actions
  • Prefer specific, actionable guidance over generic messages

Structs§

ErrorHint
A remediation hint for an error.

Functions§

format_error_with_hints
Format an error with its hints for display.
hints_for_error
Get remediation hints for an error variant.