Improve documentation in README. #10
Merged
Conversation
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
baileydoestech
requested changes
Apr 16, 2019
README.md
Outdated
| This library provides a `ToActionResult` extension method for `Result<TData>` which converts it to an appropriate `IActionResult`. | ||
| There are various overloads to provide flexibiility. | ||
| `Result<TData>` is a type defined in the `Winton.DomainModelling.Abstractions` package. | ||
| It is a type that is intended to be returned from domain operations. |
There was a problem hiding this comment.
I think these points would be easy to read as bullet points
README.md
Outdated
|
|
||
| If the `Result<TData>` was a success then we typically want to return a 2xx response from the API containing the data in the body. | ||
| If the `Result<TData>` was a failure then we typically want to return a 4xx response from the API containg [problem details](https://tools.ietf.org/html/rfc7807) in the body. | ||
| This library, therefore, provides a `ToActionResult` extension method for `Result<TData>` which matches on the result and converts it to an appropriate `IActionResult`. |
There was a problem hiding this comment.
Not sure 'therefore' is adding anything here
baileydoestech
approved these changes
Apr 16, 2019
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.
No description provided.