Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove repeat words #1471

Closed
wants to merge 3 commits into from
Closed

chore: remove repeat words #1471

wants to merge 3 commits into from

Conversation

fivecut
Copy link
Contributor

@fivecut fivecut commented Jun 13, 2024

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

remove repeat words

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • Documentation
    • Corrected typographical errors in the API documentation for JSON-RPC endpoints and Cronos events specification. These changes clarify the usage of parameters and improve readability.

Signed-off-by: fivecut <fivecut@126.com>
@fivecut fivecut requested a review from a team as a code owner June 13, 2024 06:45
@fivecut fivecut requested review from yihuang and thomas-nguy and removed request for a team June 13, 2024 06:45
Copy link
Contributor

coderabbitai bot commented Jun 13, 2024

Walkthrough

The recent updates make minor but essential corrections in the documentation, specifically fixing typographical errors. The first correction pertains to the blockhash parameter documentation in the Ethereum JSON-RPC API, clarifying the filter usage based on block hash. The second adjustment fixes a duplicated word in the Cosmos SDK Baseapp events documentation, enhancing readability and accuracy.

Changes

File Change Summary
docs/api/json-rpc/endpoints.md Corrected typo in blockhash parameter description for EIP-234 filter usage.
x/cronos/spec/06_events.md Fixed duplicated phrase "the the" in Cosmos SDK Baseapp events documentation.

Poem

Amidst the code, where changes tread,
Clarity, like sunlight, spreads. 🌞
Errors fixed, now shines so bright,
Documentation's pure delight! 📚
Typo-free, we stride anew,
Every word now clear and true. ✨


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 90ac130 and 8aaddf8.

Files selected for processing (2)
  • docs/api/json-rpc/endpoints.md (1 hunks)
  • x/cronos/spec/06_events.md (1 hunks)
Additional context used
LanguageTool
x/cronos/spec/06_events.md

[uncategorized] ~9-~9: The abbreviation “i.e.” (= that is) requires two periods. (I_E)
Context: ... emitted by the Cosmos SDK's Baseapp (i.e the basic application that implements T...

docs/api/json-rpc/endpoints.md

[misspelling] ~139-~139: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_serverInfo ...


[misspelling] ~140-~140: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_clientInfo ...


[misspelling] ~141-~141: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_priorityClientInfo ...


[misspelling] ~142-~142: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_addBalance ...


[misspelling] ~143-~143: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_setClientParams ...


[misspelling] ~144-~144: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_setDefaultParams ...


[misspelling] ~145-~145: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_latestCheckpoint ...


[misspelling] ~146-~146: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_getCheckpoint ...


[misspelling] ~147-~147: Did you mean “less” instead of the French article “les”? (LES_LESS)
Context: ... | | | | les_getCheckpointContractAddress ...


[style] ~223-~223: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...,"result":23} ``` ### net_listening Returns if client is actively listening for net...


[style] ~285-~285: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...893cd7f0"]} ### `eth_blockNumber` Returns the current block height. json // R...


[style] ~297-~297: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ult":"0x66"} ``` ### eth_getBalance Returns the account balance for a given account...


[uncategorized] ~404-~404: When ‘Ethereum-specific’ is used as a modifier, it is usually spelled with a hyphen. (SPECIFIC_HYPHEN)
Context: ..._sign Thesignmethod calculates an Ethereum specific signature with:sign(keccak256("\x19Et...


[uncategorized] ~406-~406: When ‘Ethereum-specific’ is used as a modifier, it is usually spelled with a hyphen. (SPECIFIC_HYPHEN)
Context: ...calculated signature recognizable as an Ethereum specific signature. This prevents misuse where a...


[uncategorized] ~434-~434: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...meters - Object containing: from: DATA, 20 Bytes - The address the tran...


[grammar] ~434-~434: Consider using either the past participle “sent” or the present participle “sending” here. (BEEN_PART_AGREEMENT)
Context: ... Bytes - The address the transaction is send from. to: DATA, 20 Bytes - (op...


[uncategorized] ~436-~436: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... the transaction is send from. to: DATA, 20 Bytes - (optional when creat...


[uncategorized] ~438-~438: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...e transaction is directed to. gas: QUANTITY - (optional, default: 90000) I...


[uncategorized] ~440-~440: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... will return unused gas. gasPrice: QUANTITY - (optional, default: To-Be-De...


[uncategorized] ~442-~442: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...rice used for each paid gas value: QUANTITY - value sent with this transac...


[uncategorized] ~444-~444: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...e sent with this transaction data: DATA - The compiled code of a contrac...


[uncategorized] ~446-~446: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s see Ethereum Contract ABI nonce: QUANTITY - (optional) Integer of a nonc...


[misspelling] ~475-~475: This word is normally spelled as one. (EN_COMPOUNDS_BLOCK_CHAIN)
Context: ...y without creating a transaction on the block chain. #### Parameters - Object containing:...


[uncategorized] ~481-~481: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...meters - Object containing: from: DATA, 20 Bytes - (optional) The addre...


[uncategorized] ~483-~483: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... the transaction is sent from. to: DATA, 20 Bytes - The address the tran...


[uncategorized] ~485-~485: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...e transaction is directed to. gas: QUANTITY - gas provided for the transac...


[uncategorized] ~487-~487: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...eded by some executions. gasPrice: QUANTITY - gasPrice used for each paid ...


[uncategorized] ~489-~489: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...rice used for each paid gas value: QUANTITY - value sent with this transac...


[uncategorized] ~491-~491: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...e sent with this transaction data: DATA - (optional) Hash of the method ...


[uncategorized] ~511-~511: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...meters - Object containing: from: DATA, 20 Bytes - The address the tran...


[grammar] ~511-~511: Consider using either the past participle “sent” or the present participle “sending” here. (BEEN_PART_AGREEMENT)
Context: ... Bytes - The address the transaction is send from. to: DATA, 20 Bytes - (op...


[uncategorized] ~513-~513: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... the transaction is send from. to: DATA, 20 Bytes - (optional when creat...


[uncategorized] ~515-~515: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...transaction is directed to. value: QUANTITY - value sent with this trans...


[uncategorized] ~713-~713: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s - Object containing: fromBlock: QUANTITY|TAG - (optional, default: `"...


[uncategorized] ~715-~715: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...t yet mined transactions. toBlock: QUANTITY|TAG - (optional, default: `"...


[uncategorized] ~717-~717: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...t yet mined transactions. address: DATA|Array, 20 Bytes - (optional) Con...


[uncategorized] ~719-~719: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ich logs should originate. topics: Array of DATA, - (optional) Array of ...


[grammar] ~733-~733: There may an error in the verb form ‘be send’. (MD_BE_NON_VBP)
Context: ...rns the account the mining rewards will be send to. ```json // Request curl -X POST --...


[grammar] ~772-~772: Consider using either the past participle “sent” or the present participle “sending” here. (BEEN_PART_AGREEMENT)
Context: ...on a notification with relevant data is send together with the subscription id. ###...


[uncategorized] ~930-~930: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...meters - Object containing: from: DATA, 20 Bytes - The address the tran...


[grammar] ~930-~930: Consider using either the past participle “sent” or the present participle “sending” here. (BEEN_PART_AGREEMENT)
Context: ... Bytes - The address the transaction is send from. to: DATA, 20 Bytes - (op...


[uncategorized] ~932-~932: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... the transaction is send from. to: DATA, 20 Bytes - (optional when creat...


[uncategorized] ~934-~934: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...transaction is directed to. value: QUANTITY - value sent with this transac...


[uncategorized] ~952-~952: When ‘Ethereum-specific’ is used as a modifier, it is usually spelled with a hyphen. (SPECIFIC_HYPHEN)
Context: ...ion. ::: The sign method calculates an Ethereum specific signature with: `sign(keccack256("\x19E...


[style] ~996-~996: ‘exact same’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_EXACT_SAME)
Context: ...l attempt to run the transaction in the exact same manner as it was executed on the networ...


[style] ~996-~996: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ...transaction that may have been executed prior to this one before it will finally attempt...

Markdownlint
docs/api/json-rpc/endpoints.md

547-547: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces


159-159: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


763-763: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


1026-1026: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


1162-1162: null (MD024, no-duplicate-heading)
Multiple headings with the same content


18-18: null (MD051, link-fragments)
Link fragments should be valid


19-19: null (MD051, link-fragments)
Link fragments should be valid


20-20: null (MD051, link-fragments)
Link fragments should be valid


21-21: null (MD051, link-fragments)
Link fragments should be valid


22-22: null (MD051, link-fragments)
Link fragments should be valid


23-23: null (MD051, link-fragments)
Link fragments should be valid


24-24: null (MD051, link-fragments)
Link fragments should be valid


25-25: null (MD051, link-fragments)
Link fragments should be valid


26-26: null (MD051, link-fragments)
Link fragments should be valid


27-27: null (MD051, link-fragments)
Link fragments should be valid


28-28: null (MD051, link-fragments)
Link fragments should be valid


29-29: null (MD051, link-fragments)
Link fragments should be valid


30-30: null (MD051, link-fragments)
Link fragments should be valid


31-31: null (MD051, link-fragments)
Link fragments should be valid


32-32: null (MD051, link-fragments)
Link fragments should be valid


33-33: null (MD051, link-fragments)
Link fragments should be valid


34-34: null (MD051, link-fragments)
Link fragments should be valid


35-35: null (MD051, link-fragments)
Link fragments should be valid


36-36: null (MD051, link-fragments)
Link fragments should be valid


37-37: null (MD051, link-fragments)
Link fragments should be valid


38-38: null (MD051, link-fragments)
Link fragments should be valid


39-39: null (MD051, link-fragments)
Link fragments should be valid


40-40: null (MD051, link-fragments)
Link fragments should be valid


41-41: null (MD051, link-fragments)
Link fragments should be valid


42-42: null (MD051, link-fragments)
Link fragments should be valid


43-43: null (MD051, link-fragments)
Link fragments should be valid


44-44: null (MD051, link-fragments)
Link fragments should be valid


45-45: null (MD051, link-fragments)
Link fragments should be valid


46-46: null (MD051, link-fragments)
Link fragments should be valid


47-47: null (MD051, link-fragments)
Link fragments should be valid


48-48: null (MD051, link-fragments)
Link fragments should be valid


49-49: null (MD051, link-fragments)
Link fragments should be valid


50-50: null (MD051, link-fragments)
Link fragments should be valid


61-61: null (MD051, link-fragments)
Link fragments should be valid


67-67: null (MD051, link-fragments)
Link fragments should be valid


68-68: null (MD051, link-fragments)
Link fragments should be valid


69-69: null (MD051, link-fragments)
Link fragments should be valid


70-70: null (MD051, link-fragments)
Link fragments should be valid


71-71: null (MD051, link-fragments)
Link fragments should be valid


72-72: null (MD051, link-fragments)
Link fragments should be valid


73-73: null (MD051, link-fragments)
Link fragments should be valid


74-74: null (MD051, link-fragments)
Link fragments should be valid


75-75: null (MD051, link-fragments)
Link fragments should be valid


76-76: null (MD051, link-fragments)
Link fragments should be valid


77-77: null (MD051, link-fragments)
Link fragments should be valid


133-133: null (MD051, link-fragments)
Link fragments should be valid


148-148: null (MD051, link-fragments)
Link fragments should be valid


149-149: null (MD051, link-fragments)
Link fragments should be valid


150-150: null (MD051, link-fragments)
Link fragments should be valid


151-151: null (MD051, link-fragments)
Link fragments should be valid


152-152: null (MD051, link-fragments)
Link fragments should be valid


153-153: null (MD051, link-fragments)
Link fragments should be valid


154-154: null (MD051, link-fragments)
Link fragments should be valid


155-155: null (MD051, link-fragments)
Link fragments should be valid


156-156: null (MD051, link-fragments)
Link fragments should be valid


157-157: null (MD051, link-fragments)
Link fragments should be valid


459-459: null (MD051, link-fragments)
Link fragments should be valid


894-894: null (MD051, link-fragments)
Link fragments should be valid


894-894: null (MD051, link-fragments)
Link fragments should be valid


920-920: null (MD051, link-fragments)
Link fragments should be valid


976-976: null (MD051, link-fragments)
Link fragments should be valid


982-982: null (MD051, link-fragments)
Link fragments should be valid

Additional comments not posted (1)
docs/api/json-rpc/endpoints.md (1)

721-721: Clarify the blockHash parameter usage for eth_getLogs.

The modification made to the description of the blockHash parameter under the eth_getLogs method is clear and improves the documentation by specifying its usage according to EIP-234. This change ensures that users are well-informed about how to use this parameter effectively.

x/cronos/spec/06_events.md Show resolved Hide resolved
@fivecut
Copy link
Contributor Author

fivecut commented Jul 25, 2024

friendly ping~

@yihuang
Copy link
Collaborator

yihuang commented Jul 25, 2024

friendly ping~

the new commit need to sign as well ;D

@fivecut fivecut closed this by deleting the head repository Jul 25, 2024
@fivecut
Copy link
Contributor Author

fivecut commented Jul 25, 2024

friendly ping~

the new commit need to sign as well ;D

Thanks. I open a new pr and signed. #1525

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants