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

Fix Minor Documentation Errors #12601

Merged
merged 3 commits into from
Nov 18, 2024
Merged

Fix Minor Documentation Errors #12601

merged 3 commits into from
Nov 18, 2024

Conversation

mdqst
Copy link
Contributor

@mdqst mdqst commented Nov 16, 2024

Changes made

  1. book/run/config.md:

    • "which download historical headers" has been corrected to "which downloads historical headers". This correction is necessary because the context implies an ongoing action, so the verb should be in the singular present form.
    • "which download historical block bodies" has also been corrected to "which downloads historical block bodies" for consistency with the previous fix.
    • "The amount of transactions" has been corrected to "The number of transactions". This change ensures grammatical accuracy, as "amount" is typically used for uncountable nouns, while "number" should be used with countable nouns like "transactions".
  2. book/run/sync-op-mainnet.md:

    • "bedrock state" has been updated to "Bedrock state" to properly capitalize the term, which refers to a specific technology or state related to OP mainnet.
  3. book/run/transactions.md:

    • "EIP-4844 Transaction" has been changed to "EIP-4844 Transactions". The plural form is required here, as the documentation refers to the general category of transactions, not just a single transaction.

Importance

The changes in this PR are critical for ensuring that the documentation is clear, accurate, and professionally written. Correct grammatical usage helps prevent confusion for users and contributors who rely on the documentation for accurate information. The specific terminology changes also make sure that the technical terms and concepts are presented properly, aligning with industry standards and best practices.

Thank you for reviewing this PR!

Several potential typos or inconsistencies have been found and corrected.
@mdqst mdqst requested a review from gakonst as a code owner November 16, 2024 11:09
@mattsse mattsse merged commit 773f558 into paradigmxyz:main Nov 18, 2024
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