Add AppendErrors method and update documentation/tests #125
Conversation
This file contains 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
- Added a new section in the `README.md` for the `AppendErrors` method. - Introduced the `AppendErrors` method in `ErrorOr.AggregationExtensions.cs`. - Added detailed XML documentation for the `AppendErrors` method. - Added new tests in `ErrorOr.AggregationExtensionsTests.cs` for `AppendErrors`. - Added a mock `User` class for testing purposes. - Updated `ErrorOr.cs` with new static methods `FromError` and `FromValue`. - Made minor namespace adjustments in `ErrorOr.InstantiationTests.cs`. - Updated `ErrorOr.sln.DotSettings.user` with new unit test session entries. - Removed a redundant link and added a new link for `AppendErrors` in the `README.md`. - Added a placeholder for a code snippet in the `README.md`.
Enhance the `ErrorOr` functionality by adding new methods and updating existing ones. * **README.md**: - Add a section on enhancements related to the `ErrorOr` functionality. - Mention the new methods and their usage. * **src/ErrorOr/ErrorOr.AggregationExtensions.cs**: - Add `AppendErrorsWithMetadata` method to append errors with additional metadata. * **src/ErrorOr/ErrorOr.cs**: - Add `FromTuple` method to create `ErrorOr` instances from tuples. - Add `FromCustom` method to create `ErrorOr` instances from custom objects. * **src/ErrorOr/ErrorOr.Else.cs**: - Add `ElseWithMetadata` and `ElseWithMetadataAsync` methods to handle errors with additional metadata. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/alnaimi-github/error-or?shareId=XXXX-XXXX-XXXX-XXXX).
Enhance ErrorOr functionality
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 pull request introduces several changes to the
ErrorOrlibrary, focusing on adding new functionality, enhancing documentation, and updating tests. The most important changes include the addition of theAppendErrorsmethod, new tests for this method, and updates to the documentation to reflect these changes.New Functionality:
AppendErrorsmethod inErrorOr.AggregationExtensionsto allow appending additional errors to an existingErrorOrresult.FromErrorandFromValuemethods inErrorOrto create instances from a list of errors or a value, respectively.Documentation Updates:
README.mdto include information and examples for the newAppendErrorsmethod. [1] [2] [3] [4]Testing Enhancements:
AppendErrorsmethod inErrorOr.AggregationExtensionsTests. These tests cover various scenarios, including handling null and empty arrays, appending multiple errors, and ensuring the method works with different data types.Userclass for testing purposes inErrorOr.AggregationExtensionsTests.User.Configuration File Changes:
ErrorOr.sln.DotSettings.userfile with new unit test session entries.These changes collectively enhance the functionality and robustness of the
ErrorOrlibrary while ensuring the documentation and tests are up-to-date.