Fix: readme typos #18
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR corrects spelling, grammar, and clarity issues in the README.md.
- Fixes typos and wording to improve readability
- Updates links and adds context for an external Python library
Comments suppressed due to low confidence (4)
README.md:12
- The phrase "look a table" seems to be missing a preposition; consider changing it to "look at a table of endpoints on the platform".
to look a table of endpoints on the platform, and will pull and wrangle
README.md:26
- Consider specifying what should be adapted, e.g., "use and adapt this app to their specific needs" for clarity.
But others are welcome to use and adapt to their specific needs.
README.md:58
- The link points to the
ruffrepository instead ofuv; update the URL to the correctuvinstallation documentation.
users should have it installed locally. Read the `uv` [installation instructions](https://github.com/astral-sh/ruff?tab=readme-ov-file#installation)
README.md:59
- The phrase is missing "to" and "in": consider "for steps on how to install it in your local environment."
on GitHub for steps on how install it your local environment.
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 focuses on correcting typos and improving the clarity of the
README.mdfile. The changes primarily address spelling errors, grammar issues, and minor wording adjustments to enhance readability and accuracy.Typo Corrections:
[[1]](https://github.com/CT-DPH-Data-Management-and-Governance/api-data-flow/pull/18/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L11-R11),[[2]](https://github.com/CT-DPH-Data-Management-and-Governance/api-data-flow/pull/18/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L44-R47))[README.mdL54-R57](https://github.com/CT-DPH-Data-Management-and-Governance/api-data-flow/pull/18/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L54-R57))[README.mdL68-R71](https://github.com/CT-DPH-Data-Management-and-Governance/api-data-flow/pull/18/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L68-R71))Grammar and Clarity Improvements:
[README.mdL26-R29](https://github.com/CT-DPH-Data-Management-and-Governance/api-data-flow/pull/18/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L26-R29))[README.mdL26-R29](https://github.com/CT-DPH-Data-Management-and-Governance/api-data-flow/pull/18/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L26-R29))