typos corrected and added some explanations #8
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
loren
requested changes
Dec 31, 2023
README.md
Outdated
| @@ -18,9 +18,9 @@ Sinker is built by [Paradigm](https://www.paradigm.xyz/), and is licensed under | |||
|
|
|||
| In Postgres, you might have a normalized schema like this: | |||
|
|
|||
| - A Student and a Teacher refer to a Person | |||
| - A Student and a Teacher refers to a Person | |||
README.md
Outdated
| - A Course is taught by a Teacher | ||
| - Students have and belong to many Courses through the Enrollment join table | ||
| - Students have taken and belong to many Courses through the Enrollment join table |
There was a problem hiding this comment.
I'd prefer to keep this language as HABTM is a standard way to indicate a many-to-many relationship.
README.md
Outdated
| @@ -78,7 +78,7 @@ Sinker creates triggers on the Postgres tables that you want to synchronize (e.g | |||
| above). When a row is inserted, updated, or deleted in any of these tables, the trigger schedules the materialized view | |||
| to be refreshed at the next interval. | |||
|
|
|||
| The changes to the materialized view are sent to a logical replication slot. Sinker reads from this slot and indexes the | |||
| The changes into the materialized view are sent to a logical replication slot. Sinker reads from this slot and indexes the | |||
There was a problem hiding this comment.
I think "changes to" is correct as is.
| @@ -331,7 +331,7 @@ Spin up Postgres and Elasticsearch: | |||
| docker-compose --env-file=.env.test up -d | |||
| ``` | |||
|
|
|||
| Run tests: | |||
| Run tests (with -s option to allow more verbose output): | |||
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8 +/- ##
=======================================
Coverage 95.12% 95.12%
=======================================
Files 8 8
Lines 246 246
=======================================
Hits 234 234
Misses 12 12 ☔ View full report in Codecov by Sentry. |
|
Thank you for your attention. I have made the requested corrections. Thanks again :) |
loren
approved these changes
Jan 2, 2024
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.
Minor typos corrected and explanations added.