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

Correct Documentation Language and Formatting #134

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

Conversation

savvar9991
Copy link

@savvar9991 savvar9991 commented Dec 27, 2024

1. Replace "betweens" with "between"

Reason: The word "betweens" is not typically used in English. The correct form is "between", which is used to describe the position or relationship between two entities or locations.

2. Replace "From root directory" with "From the root directory"

Change: Adding the article "the" to "From root directory" to make it grammatically correct.
Reason: In English, when referring to a specific place or object, the article "the" is often required before the noun. In this case, "root directory" refers to a specific location in a file system, so "the" should be added.

3. Replace "Gas estimation" with "Gas Estimation"

Reason: In technical documentation, certain terms like "Gas Estimation" may be capitalized to indicate that it is a specific feature, concept, or heading.

4. Ethers.js Typo

The sentence has a small issue with the use of "Ethers-js." The correct name of the library is "Ethers.js" (with a dot instead of a hyphen).

5. Fill Information Phrase

The sentence has a small mistake in the phrase "fill the information of your chain." A more natural and grammatically correct phrase would be:

"fill in the information of your chain"

Copy link
Contributor

@TucksonDev TucksonDev left a comment

Choose a reason for hiding this comment

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

Thanks! One minor change and it should be ready

README.md Outdated Show resolved Hide resolved
Co-authored-by: José FP <[email protected]>
@savvar9991
Copy link
Author

Hi @TucksonDev
Applied the suggested change. Thanks for the review!

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