Fix: Documentation Typos and Improve Clarity #2232
Conversation
WalkthroughThe pull request includes several modifications to documentation files aimed at improving clarity and correcting typographical errors. Changes were made to Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
docs/transaction_proposal.md (2)
33-33: Add missing commas for better readabilityConsider adding commas to improve readability:
-In order to propose we need a json file containing our messages to run if the proposal passes. +In order to propose, we need a json file containing our messages to run if the proposal passes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: A comma might be missing here.
Context: .... ## Creating the Proposal In order to propose we need a json file containing our mess...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~33-~33: Consider a shorter alternative to avoid wordiness.
Context: ... only be stored if the proposal passes. In order to obtain the JSON for this transaction th...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~33-~33: A comma might be missing here.
Context: ...s. In order to obtain the JSON for this transaction the following command can be run. `pro...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
75-75: Add missing comma in the instructionAdd a comma after "To propose it":
-To propose it the following command can be run: +To propose it, the following command can be run:🧰 Tools
🪛 LanguageTool
[typographical] ~75-~75: It seems that a comma is missing.
Context: ...been sent out to Provenance. To propose it the following command can be run: `pro...(IN_ORDER_TO_VB_COMMA)
docs/Preauthorization.md (1)
17-17: Enhance readability of the spend-limit explanationConsider restructuring the paragraph for better readability:
-The flag `spend-limit` is used to set the total amount of coin that can be transferred. Each transfer will deduct from this total until it is exhausted at which point no more transfers can be made. However, the spend limit can be reset by the user doing another pre-authorize transaction. Note that this new spend limit does not take into account what has already been spent. So, for example if you grant permissions to transfer 100 coins and 50 are transferred and then you set a new spend limit of 75, that allows the user to now transfer 75 coins. The previously spent coins are not taken into account with the new spend limit. +The flag `spend-limit` sets the total amount of coin that can be transferred. Each transfer deducts from this total until exhausted, after which no more transfers can be made. The spend limit can be reset through another pre-authorize transaction. Important notes: + +- The new spend limit is independent of previously spent amounts +- For example, if you: + 1. Grant permission to transfer 100 coins + 2. Transfer 50 coins + 3. Set a new spend limit of 75 +Then the user can transfer 75 more coins, regardless of the previous 50-coin transfer.🧰 Tools
🪛 LanguageTool
[style] ~17-~17: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...Note that this new spend limit does not take into account what has already been spent. So, for e...(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...t what has already been spent. So, for example if you grant permissions to transfer 10...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~17-~17: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ransfer 100 coins and 50 are transferred and then you set a new spend limit of 75, t...(COMMA_COMPOUND_SENTENCE)
[style] ~17-~17: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...ns. The previously spent coins are not taken into account with the new spend limit. If a user w...(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
docs/Preauthorization.md(1 hunks)docs/grpcurl.md(1 hunks)docs/state-sync.md(1 hunks)docs/transaction_proposal.md(4 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/grpcurl.md
🧰 Additional context used
🪛 LanguageTool
docs/Preauthorization.md
[style] ~17-~17: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...Note that this new spend limit does not take into account what has already been spent. So, for e...
(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...t what has already been spent. So, for example if you grant permissions to transfer 10...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~17-~17: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ransfer 100 coins and 50 are transferred and then you set a new spend limit of 75, t...
(COMMA_COMPOUND_SENTENCE)
[style] ~17-~17: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ...ns. The previously spent coins are not taken into account with the new spend limit. If a user w...
(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)
docs/transaction_proposal.md
[uncategorized] ~33-~33: A comma might be missing here.
Context: .... ## Creating the Proposal In order to propose we need a json file containing our mess...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~33-~33: Consider a shorter alternative to avoid wordiness.
Context: ... only be stored if the proposal passes. In order to obtain the JSON for this transaction th...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~33-~33: A comma might be missing here.
Context: ...s. In order to obtain the JSON for this transaction the following command can be run. `pro...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~75-~75: It seems that a comma is missing.
Context: ...been sent out to Provenance. To propose it the following command can be run: `pro...
(IN_ORDER_TO_VB_COMMA)
🔇 Additional comments (1)
docs/state-sync.md (1)
78-78: Consider using DNS hostnames instead of hardcoded IPs
While the current implementation uses a hardcoded IP as a temporary workaround, this approach may cause maintenance issues if the IP changes. Consider:
- Using DNS hostnames for better maintainability
- Adding a comment with an expiration date for the temporary workaround
- Creating a tracking issue to implement a permanent solution
Let's verify if the IP is still active and if there are any DNS records we could use instead:
Description
This PR fixes several typos and minor documentation errors across multiple files for better clarity and professionalism. The updates include:
Preauthorization.md: Correctedtransfered→transferredand refined explanations.grpcurl.md: FixedDescrie→Describeand improved phrasing.state-sync.md: Addressedtesntet→testnetand other minor adjustments.transaction_proposal.md: FixedPrequisites→Prerequisitesandran→run.These changes ensure a smoother reading experience and reduce ambiguity for developers.
closes: #XXXX
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/).godoccomments (n/a: no code changes)..changelog/unreleased(see Adding Changes).Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes (n/a: documentation-only changes).Summary by CodeRabbit
Preauthorization.md,grpcurl.md,state-sync.md, andtransaction_proposal.mddocuments.