Improve clarity and consistency of user‑facing error messages #4

Open
opened 2026-04-07 10:55:17 +01:00 by mon · 0 comments
Owner

Some of the messages printed by UpdateDnsCommand and related classes are terse, inconsistent, or overly technical. Improving these messages would make the tool easier to understand when something goes wrong, especially for users running it manually or reviewing logs.

Proposed enhancements

  • Standardize the tone and structure of error messages
  • Make messages more descriptive (e.g., “Could not retrieve DNS records for example.com” instead of “Invalid records”)
  • Include relevant context when helpful (domain, record name, expected vs actual values)
  • Avoid leaking raw API responses unless necessary
  • Ensure messages are consistent across all error paths

Benefits

  • Better UX for manual runs
  • Clearer logs for debugging
  • More predictable behavior for future contributors
Some of the messages printed by `UpdateDnsCommand` and related classes are terse, inconsistent, or overly technical. Improving these messages would make the tool easier to understand when something goes wrong, especially for users running it manually or reviewing logs. **Proposed enhancements** - Standardize the tone and structure of error messages - Make messages more descriptive (e.g., “Could not retrieve DNS records for example.com” instead of “Invalid records”) - Include relevant context when helpful (domain, record name, expected vs actual values) - Avoid leaking raw API responses unless necessary - Ensure messages are consistent across all error paths **Benefits** - Better UX for manual runs - Clearer logs for debugging - More predictable behavior for future contributors
mon self-assigned this 2026-04-07 10:55:24 +01:00
Sign in to join this conversation.
No Label
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: mon/pb-dydns#4
No description provided.