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§
- Error
Hint - 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.