Skip to content

docs: enhance error handling types with conversion implementations an…#58

Merged
TKorr merged 1 commit intomainfrom
fix/error-api-guidelines
Mar 22, 2026
Merged

docs: enhance error handling types with conversion implementations an…#58
TKorr merged 1 commit intomainfrom
fix/error-api-guidelines

Conversation

@TKorr
Copy link
Contributor

@TKorr TKorr commented Mar 22, 2026

…d examples

Added From<String> and From<&str> implementations for InvariantError and ConfigError to facilitate easier creation from string types. Updated documentation for both error types to include usage examples, clarifying their construction and expected message formats. This change improves usability and consistency in error handling across the library.

Description

Related Issue

Fixes #

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🔧 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🧪 Test addition or modification

How Has This Been Tested?

  • Unit tests
  • Integration tests
  • Manual testing

Test environment:

  • OS:
  • Rust version:

Checklist

  • My code follows the project's coding standards
  • I have run cargo fmt and cargo clippy
  • I have added tests for my changes
  • All new and existing tests pass (cargo test)
  • I have updated the documentation as needed
  • I have added an entry to CHANGELOG.md (if applicable)

Screenshots (if applicable)

Additional Notes

…d examples

Added `From<String>` and `From<&str>` implementations for `InvariantError` and `ConfigError` to facilitate easier creation from string types. Updated documentation for both error types to include usage examples, clarifying their construction and expected message formats. This change improves usability and consistency in error handling across the library.
@TKorr TKorr merged commit aa3a71b into main Mar 22, 2026
17 checks passed
@TKorr TKorr deleted the fix/error-api-guidelines branch March 22, 2026 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant