Updates the README with descriptions of Orville some sample code #338
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
AugmenTab
reviewed
Oct 27, 2023
docs/README.md
Outdated
| ## Why Orville? | ||
|
|
||
| Orville is not meant to replace existing PostgreSQL libraries in the Haskell | ||
| ecosystem, but to complement them. It has the power to satsify most experienced |
docs/README.md
Outdated
Comment on lines
25
to
26
| hand yet doesn't require absolute type-safety between your custom SQL | ||
| statements result sets and the Haskell types they decode into, Orville may be |
There was a problem hiding this comment.
Did you mean "your custom SQL statements' result sets" here?
There was a problem hiding this comment.
Really I think it should be "your customs SQL statements, their result sets and...". Thanks!
docs/README.md
Outdated
|
|
||
| ## Just show me some code! | ||
|
|
||
| Ok! Here's a very simple application that inserts to entities of a `Pet` model and finds one of them based on its name. |
There was a problem hiding this comment.
I think the "to" here is unnecessary.
There was a problem hiding this comment.
You're right. It should probably say "inserts some entities" though rather than just "inserts entities"
Comment on lines
+71
to
+74
| {- | | ||
| It's good practice to create newtype specific to each entity to hold its | ||
| primary key value | ||
| -} |
There was a problem hiding this comment.
newtype -> newtypes; missing period at end of comment.
Comment on lines
+102
to
+105
| {- | | ||
| Marshaller above is associated with the @pet@ table. The marshallers fields | ||
| will define the column of the table. | ||
| -} |
There was a problem hiding this comment.
marshallers -> marshaller's; column -> columns
AugmenTab
approved these changes
Oct 27, 2023
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 is probably easiest to review by browsing files on the commit to merge here: https://github.com/flipstone/orville/tree/42fb5446cb5dd5f394cac1480b7fcf28642bb7e9