docs: Cleanup README grammar, punctuation, and capitalization #654
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
dfsnow
commented
May 20, 2024
dfsnow
commented
May 20, 2024
dfsnow
changed the title
dfsnow
requested review from
jessedobbelaere,
Jrmyy,
mattiamatrix,
nicor88 and
svdimchenko
as code owners
Jrmyy
reviewed
May 21, 2024
|
Great stuff 👍 After merging, I'll also do a comparison with https://github.com/dbt-athena/dbt-athena.github.io to check how we can improve there (we can be a lot more verbose on the doc site than in the readme, and provide examples etc) 👌 |
Co-authored-by: Jérémy Guiselin <[email protected]>
Jrmyy
approved these changes
May 21, 2024
kodiakhq bot
referenced
this pull request
in cloudquery/policies
Jun 5, 2024
This PR contains the following updates: | Package | Update | Change | |---|---|---| | [dbt-athena-community](https://togithub.com/dbt-athena/dbt-athena) | minor | `==1.7.2` -> `==1.8.2` | --- ### Release Notes <details> <summary>dbt-athena/dbt-athena (dbt-athena-community)</summary> ### [`v1.8.2`](https://togithub.com/dbt-athena/dbt-athena/releases/tag/v1.8.2) [Compare Source](https://togithub.com/dbt-athena/dbt-athena/compare/v1.8.1...v1.8.2) ### What's Changed #### Fixes - fix: Add wait_random_exponential for query retries by [@​svdimchenko](https://togithub.com/svdimchenko) in [https://github.com/dbt-athena/dbt-athena/pull/655](https://togithub.com/dbt-athena/dbt-athena/pull/655) - fix: Resolve error when cloning Python models ([#​645](https://togithub.com/dbt-athena/dbt-athena/issues/645)) by [@​jeancochrane](https://togithub.com/jeancochrane) in [https://github.com/dbt-athena/dbt-athena/pull/651](https://togithub.com/dbt-athena/dbt-athena/pull/651) - fix: Fixed table_type for GOVERNED tables by [@​svdimchenko](https://togithub.com/svdimchenko) in [https://github.com/dbt-athena/dbt-athena/pull/661](https://togithub.com/dbt-athena/dbt-athena/pull/661) #### Features - feat: Set unique table suffix to allow parallel incremental executions by [@​pierrebzl](https://togithub.com/pierrebzl) in [https://github.com/dbt-athena/dbt-athena/pull/650](https://togithub.com/dbt-athena/dbt-athena/pull/650) - feat: Allow custom schema def for tmp tables generated by incremental by [@​pierrebzl](https://togithub.com/pierrebzl) in [https://github.com/dbt-athena/dbt-athena/pull/659](https://togithub.com/dbt-athena/dbt-athena/pull/659) - feat: Implement iceberg retry logic by [@​svdimchenko](https://togithub.com/svdimchenko) in [https://github.com/dbt-athena/dbt-athena/pull/657](https://togithub.com/dbt-athena/dbt-athena/pull/657) #### Dependencies - chore: Update moto requirement from ~=5.0.7 to ~=5.0.8 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/dbt-athena/dbt-athena/pull/660](https://togithub.com/dbt-athena/dbt-athena/pull/660) - chore: Bumped version to 1.8.2 for release by [@​svdimchenko](https://togithub.com/svdimchenko) in [https://github.com/dbt-athena/dbt-athena/pull/663](https://togithub.com/dbt-athena/dbt-athena/pull/663) #### Docs - docs: Cleanup README grammar, punctuation, and capitalisation by [@​dfsnow](https://togithub.com/dfsnow) in [https://github.com/dbt-athena/dbt-athena/pull/654](https://togithub.com/dbt-athena/dbt-athena/pull/654) #### New Contributors - [@​jeancochrane](https://togithub.com/jeancochrane) made their first contribution in [https://github.com/dbt-athena/dbt-athena/pull/651](https://togithub.com/dbt-athena/dbt-athena/pull/651) - [@​pierrebzl](https://togithub.com/pierrebzl) made their first contribution in [https://github.com/dbt-athena/dbt-athena/pull/650](https://togithub.com/dbt-athena/dbt-athena/pull/650) **Full Changelog**: dbt-labs/dbt-athena@v1.8.1...v1.8.2 ### [`v1.8.1`](https://togithub.com/dbt-athena/dbt-athena/releases/tag/v1.8.1) [Compare Source](https://togithub.com/dbt-athena/dbt-athena/compare/v1.7.2...v1.8.1) #### What's Changed ##### Relevant notes⚠️ 1.8.1 version is equivalent to 1.8.0 in term of features and fixes. You can install the changes from this release via pip install dbt-athena-community==1.8.1 ##### Features - feat: Add column meta to glue column parameters by [@​SoumayaMauthoorMOJ](https://togithub.com/SoumayaMauthoorMOJ) in [https://github.com/dbt-athena/dbt-athena/pull/644](https://togithub.com/dbt-athena/dbt-athena/pull/644) ##### Dependencies - chore: Update moto requirement from ~=5.0.6 to ~=5.0.7 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/dbt-athena/dbt-athena/pull/648](https://togithub.com/dbt-athena/dbt-athena/pull/648) ##### Docs - docs: Cleanup Python models section of README by [@​dfsnow](https://togithub.com/dfsnow) in [https://github.com/dbt-athena/dbt-athena/pull/643](https://togithub.com/dbt-athena/dbt-athena/pull/643) #### New Contributors - [@​dfsnow](https://togithub.com/dfsnow) made their first contribution in [https://github.com/dbt-athena/dbt-athena/pull/643](https://togithub.com/dbt-athena/dbt-athena/pull/643) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on the first day of the month" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zODMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjM4My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJhdXRvbWVyZ2UiXX0=-->
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.
Description
This PR cleans up some of the grammar, punctuation, and capitalization in the README. It also fixes some misspecified links (that I created! Oops), and tries to clarify some language. I've added some PR comments where I feel the README language is still unclear.
Checklist