Description
The module-level documentation in tests/error_display.rs could be enhanced to provide better context about why implementing Display and Error traits is important for the public API.
Currently, the documentation explains what is tested, but not why these traits matter for users. Adding a brief explanation of the user-facing impact (e.g., clearer logs for operators, improved error messages for developers) would aid future maintainers scanning the test suite.
Context
This suggestion emerged during code review of PR #169, where Display and Error trait implementations were added for error types.
Related Links
Requested by
@leynos
Description
The module-level documentation in
tests/error_display.rscould be enhanced to provide better context about why implementing Display and Error traits is important for the public API.Currently, the documentation explains what is tested, but not why these traits matter for users. Adding a brief explanation of the user-facing impact (e.g., clearer logs for operators, improved error messages for developers) would aid future maintainers scanning the test suite.
Context
This suggestion emerged during code review of PR #169, where Display and Error trait implementations were added for error types.
Related Links
Requested by
@leynos