chore: fix typos/grammatical errors #38
Conversation
Summary of ChangesHello @fira5dahi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the quality of the project's documentation by addressing and rectifying several minor textual inconsistencies, typos, and grammatical errors. The changes aim to provide a clearer and more professional understanding of the various concepts and features for all users and developers. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request addresses several typos and grammatical errors across the documentation files. The fixes are correct and improve the quality of the text. I've added a few suggestions on the changed lines to further enhance grammar and readability. Overall, this is a good set of improvements.
| edit the fields you want to change and copy over the fields from Step 1 that you want to keep the same. | ||
|
|
||
| - `vault` that is the address of your vault. call will fail if msg.sender is not not owner of this vault | ||
| - `vault` that is the address of your vault. call will fail if msg.sender is not owner of this vault |
There was a problem hiding this comment.
To improve clarity and grammar, I suggest rephrasing this sentence slightly.
| - `vault` that is the address of your vault. call will fail if msg.sender is not owner of this vault | |
| - `vault` is the address of your vault. The call will fail if msg.sender is not the owner of this vault |
| - `vault` that is the address of your vault. call will fail if msg.sender is not owner of this vault | ||
| - `oracle` is a smart contract which acts as onchain oracle to police executor actions. Read more about [Arrakis Price Oracles](../../text/arrakisModular/priceOracles.md) | ||
| - `maxDeviation` this is max deviation underlying module spot market can haave from oracle price (in pips) | ||
| - `maxDeviation` this is max deviation underlying module spot market can have from oracle price (in pips) |
There was a problem hiding this comment.
To improve readability and grammar, I suggest adding articles ("the") and capitalizing the start of the sentence.
| - `maxDeviation` this is max deviation underlying module spot market can have from oracle price (in pips) | |
| - `maxDeviation` This is the max deviation the underlying module spot market can have from the oracle price (in pips) |
| We are in the midst of a shift in DeFi. As Ethereum has grown, sophisticated actors have infiltrated DeFi and leveraged complex strategies to extract value from the ecosystem. | ||
|
|
||
| Naturally this has increased the scope of the [problem statement](problemStatement.md) Arrakis is tackling. It has grown to encompass recapturing MEV from centralised actors who are extractive to the ecosystem. Arrakis aims to give token issuers and LPs a fairer share of the pie. | ||
| Naturally this has increased the scope of the [problem statement](../../text/introduction/arrakisPro.md#problem-statement) Arrakis is tackling. It has grown to encompass recapturing MEV from centralised actors who are extractive to the ecosystem. Arrakis aims to give token issuers and LPs a fairer share of the pie. |
There was a problem hiding this comment.
For better readability and grammatical correctness, I suggest adding a comma after "Naturally" and adding "that" to clarify the clause.
| Naturally this has increased the scope of the [problem statement](../../text/introduction/arrakisPro.md#problem-statement) Arrakis is tackling. It has grown to encompass recapturing MEV from centralised actors who are extractive to the ecosystem. Arrakis aims to give token issuers and LPs a fairer share of the pie. | |
| Naturally, this has increased the scope of the [problem statement](../../text/introduction/arrakisPro.md#problem-statement) that Arrakis is tackling. It has grown to encompass recapturing MEV from centralised actors who are extractive to the ecosystem. Arrakis aims to give token issuers and LPs a fairer share of the pie. |
1 participant
Fixed text typos.
To consider next: some internal and external links are broken (404).