chore: fix spelling errors #20581
chore: fix spelling errors #20581
Conversation
WalkthroughThe changes in Changes
Sequence Diagram(s) (Beta)sequenceDiagram
participant User
participant CosmosSDKApp
participant StateDecoder
participant PostgreSQLIndexer
participant GraphQLEndpoint
User->>CosmosSDKApp: Queries data
CosmosSDKApp->>StateDecoder: Decodes state data
StateDecoder->>PostgreSQLIndexer: Sends decoded data
PostgreSQLIndexer->>GraphQLEndpoint: Indexes data and exposes via GraphQL
User->>GraphQLEndpoint: Queries indexed data
GraphQLEndpoint->>User: Returns query results
Possibly related issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
postgressql is a title it follows the spelling of how its meant to be spelled. We should keep it this way |
|
I cannot re-open it anymore 🙁 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (8)
docs/architecture/adr-073-indexer.md (8)
Line range hint
71-71: Correct the verb form for clarity.- which can consumed by an indexer + which can be consumed by an indexer
Line range hint
77-77: Consider simplifying these phrases to enhance readability.- in order to expose for decoding functionality and saner naming of map keys and values + to expose decoding functionality and improve naming of map keys and values - In order to support indexing from any height (`N3`) + To support indexing from any height (`N3`) - in order to provide a full-featured query experience + to provide a full-featured query experienceAlso applies to: 80-80, 93-93
Line range hint
103-103: Adjust the noun for correct agreement.- a lot of module refactoring + a lot of module refactorings
Line range hint
104-104: Simplify the expression for conciseness.- at the moment + currently
Line range hint
104-104: Add a comma for correct punctuation.- Also we want to provide a more batteries-included experience + Also, we want to provide a more batteries-included experience
Line range hint
105-105: Consider using a synonym for stylistic improvement.- it would be hard to configure custom indexes and views + it would be challenging to configure custom indexes and views
Line range hint
115-115: Correct the adjective for proper hyphenation.- client friendly + client-friendly
Line range hint
129-129: Remove the comma for grammatical correctness.- concerned out of the scope of the design, because it is either much more complex from an + concerned out of the scope of the design because it is either much more complex from an
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/architecture/adr-073-indexer.md (4 hunks)
Additional context used
Path-based instructions (1)
docs/architecture/adr-073-indexer.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
LanguageTool
docs/architecture/adr-073-indexer.md
[style] ~50-~50: This phrase is redundant. Consider writing “point” or “time”. (MOMENT_IN_TIME)
Context: ... complete query index starting from any point in time without necessarily needing to replay a...
[grammar] ~71-~71: The past tense is already expressed by ‘can’. Did you mean “consume”? (HOW_DID_THAT_HAPPEN)
Context: ...ecode it into logical packets which can consumed by an indexer. It should define an inte...
[style] ~77-~77: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...changes tocollectionswill be needed in order to expose for decoding functionality and s...
[style] ~80-~80: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...onfigured at the module or node level. In order to support indexing from any height (N3)...
[grammar] ~91-~91: The plural noun “batteries” cannot be used with the article “a”. Did you mean “a full batterie”, “a full battery” or “full batteries”? (A_NNS)
Context: ...thout needing to go through Comet. For a full batteries included, client friendly query experie...
[style] ~93-~93: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... the query indexer in the configuration in order to provide a full-featured query experienc...
[misspelling] ~101-~101: Use ‘short-term’ only as an adjective. For the adverbial phrase, use “short term”. (THE_SHORT_TERM)
Context: ... this would simplify our efforts in the short-term, it still doesn't provide a full-featur...
[grammar] ~103-~103: Possible agreement error. The noun refactoring seems to be countable; consider using: “a lot of module refactorings”. (A_LOT_OF_NN)
Context: ...e-based indexer, however, would require a lot of module refactoring, likely custom code, and wouldn't take ...
[style] ~104-~104: For conciseness, consider replacing this expression with an adverb. (AT_THE_MOMENT)
Context: ...ecodable schema forcollectionswhich at the moment is fairly complex. It is easier to use ...
[uncategorized] ~104-~104: A comma may be missing after the conjunctive/linking adverb ‘Also’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...uage for a separate process to consume. Also we want to provide a more batteries-inc...
[style] ~105-~105: To elevate your writing, try using a synonym here. (HARD_TO)
Context: ...ient only indexes in state, it would be hard to configure custom indexes and views, ...
[uncategorized] ~115-~115: The adjective “client-friendly” is spelled with a hyphen. (NN_FRIENDLY_HYPHEN)
Context: ...g ofcollectionsandormschemas is client friendly. Also, because we are separating the d...
[formatting] ~129-~129: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause. (COMMA_BEFORE_BECAUSE)
Context: ...concerned out of the scope of the design, because it is either much more complex from an ...
Markdownlint
docs/architecture/adr-073-indexer.md
41-41: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
42-42: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
43-43: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
40-40: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
111-111: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
95-95: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
|
|
||
|
|
||
| ## Alternatives | ||
|
|
||
| The following alternatives were considered: | ||
|
|
||
| * support any SQL database not just PostgreSQL using a framework like [GORM](https://gorm.io/). While this would be more flexible, it would be slower, require heavy usage of golang reflection and might limit how much we can take advantage of PostgreSQL's unique features for little benefit (the assumption being that most users would choose PostgreSQL anyway and or be happy enough that we made that choice). | ||
| * don't support any specific database, but just build the decoder framework. While this would simplify our efforts in the short-term, it still doesn't provide a full-featured solution and requires others to build out the key infrastructure similar to [ADR 038](adr-038-state-listening.md). This limbo state would not allow the SDK to definitely make key optimizations to state layout and simple the task of module development in a definitive way by providing a full replacement for gRPC client queries. |
There was a problem hiding this comment.
Correct the adverbial phrase for grammatical accuracy.
- in the short-term
+ in the short termCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * don't support any specific database, but just build the decoder framework. While this would simplify our efforts in the short-term, it still doesn't provide a full-featured solution and requires others to build out the key infrastructure similar to [ADR 038](adr-038-state-listening.md). This limbo state would not allow the SDK to definitely make key optimizations to state layout and simple the task of module development in a definitive way by providing a full replacement for gRPC client queries. | |
| * don't support any specific database, but just build the decoder framework. While this would simplify our efforts in the short term, it still doesn't provide a full-featured solution and requires others to build out the key infrastructure similar to [ADR 038](adr-038-state-listening.md). This limbo state would not allow the SDK to definitely make key optimizations to state layout and simple the task of module development in a definitive way by providing a full replacement for gRPC client queries. |
Tools
LanguageTool
[misspelling] ~101-~101: Use ‘short-term’ only as an adjective. For the adverbial phrase, use “short term”. (THE_SHORT_TERM)
Context: ... this would simplify our efforts in the short-term, it still doesn't provide a full-featur...
| @@ -86,12 +90,13 @@ | |||
|
|
|||
| For a full batteries included, client friendly query experience, a GraphQL endpoint should be exposed in the HTTP server for any PostgreSQL database that has the [Supabase pg_graphql](https://github.com/supabase/pg_graphql) extension enabled. `pg_graphql` will expose rich GraphQL queries for all PostgreSQL tables with zero code that support filtering, pagination, sorting and traversing foreign key references. (Support for defining foreign keys with `collections` and `orm` could be added in the future to take advantage of this). In addition, a [GraphiQL](https://github.com/graphql/graphiql) query explorer endpoint can be exposed to simplify client development. | |||
There was a problem hiding this comment.
Correct the grammatical error regarding plural usage.
- For a full batteries included, client friendly query experience
+ For a fully batteries-included, client-friendly query experienceCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| For a full batteries included, client friendly query experience, a GraphQL endpoint should be exposed in the HTTP server for any PostgreSQL database that has the [Supabase pg_graphql](https://github.com/supabase/pg_graphql) extension enabled. `pg_graphql` will expose rich GraphQL queries for all PostgreSQL tables with zero code that support filtering, pagination, sorting and traversing foreign key references. (Support for defining foreign keys with `collections` and `orm` could be added in the future to take advantage of this). In addition, a [GraphiQL](https://github.com/graphql/graphiql) query explorer endpoint can be exposed to simplify client development. | |
| For a fully batteries-included, client-friendly query experience, a GraphQL endpoint should be exposed in the HTTP server for any PostgreSQL database that has the [Supabase pg_graphql](https://github.com/supabase/pg_graphql) extension enabled. `pg_graphql` will expose rich GraphQL queries for all PostgreSQL tables with zero code that support filtering, pagination, sorting and traversing foreign key references. (Support for defining foreign keys with `collections` and `orm` could be added in the future to take advantage of this). In addition, a [GraphiQL](https://github.com/graphql/graphiql) query explorer endpoint can be exposed to simplify client development. |
Tools
LanguageTool
[grammar] ~91-~91: The plural noun “batteries” cannot be used with the article “a”. Did you mean “a full batterie”, “a full battery” or “full batteries”? (A_NNS)
Context: ...thout needing to go through Comet. For a full batteries included, client friendly query experie...
This PR fixes typos in the codebase.
Please review it, and merge if everything is fine.
If there are proto changes, run
make proto-genand commit the changes.Summary by CodeRabbit