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

Corrected grammatical and terminology issues in documentation #991

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

0xbryer
Copy link

@0xbryer 0xbryer commented Nov 17, 2024

Description:

This pull request addresses two issues found in the documentation files:

  1. File: website/docs/advanced/proof-of-stake-devnet.md

    • Issue: The sentence "Today, running an Ethereum node require two components:" contains a grammatical error. The word "require" should be changed to "requires" to agree with the singular subject "node."
    • Fix: The sentence is now correctly written as:

      "Today, running an Ethereum node requires two components:"

    • Importance: This fix ensures that the sentence is grammatically correct, improving readability and professionalism in the documentation.
  2. File: website/docs/advanced/switch-clients.md

    • Issue: The phrase "port forwards" is used incorrectly in the sentence: "Remove those two rules and replace them with the appropriate port forwards for the client you are switching to." The term "port forwards" should be changed to "port forwarding," as it refers to the process rather than a plural noun.
    • Fix: The corrected sentence reads:

      "Remove those two rules and replace them with the appropriate port forwarding for the client you are switching to."

    • Importance: This adjustment ensures that the terminology is accurate, helping users understand the intended action clearly and avoid confusion.

Both changes contribute to a more polished and precise documentation experience for developers and users.

The word "require" should be "requires" to match the singular subject "node."
The word "port forwards" should be "port forwarding," as it refers to the process, not a plural item.
@CLAassistant
Copy link

CLAassistant commented Nov 17, 2024

CLA assistant check
All committers have signed the CLA.

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