Improve documentation of ErrorTracker.Error kind field#154
Merged
odarriba merged 4 commits intoelixir-error-tracker:mainfrom May 12, 2025
Merged
Improve documentation of ErrorTracker.Error kind field#154odarriba merged 4 commits intoelixir-error-tracker:mainfrom
odarriba merged 4 commits intoelixir-error-tracker:mainfrom
Conversation
Closes: 153 Co-authored-by: Manmohan Krishna <manmohan.krishna@maersk.com>
Co-authored-by: Manmohan Krishna <manmohan.krishna@maersk.com>
odarriba
requested changes
May 11, 2025
Contributor
odarriba
left a comment
odarriba
left a comment
There was a problem hiding this comment.
Looks good! I just added a comment to include other fields in the type definition too.
odarriba
approved these changes
May 12, 2025
Contributor
odarriba
left a comment
odarriba
left a comment
There was a problem hiding this comment.
Awesome! Thanks for your work <3
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This addresses #153.
We thought about it and came to the conclusion that it would be good to change the type declaration for the module. Open for discussion, because that could potentially be a breaking change of the library if users previously had implementations of
ErrorTracker.Ignorerthat matched on non-string types (although, arguably those implementations would never have worked).