chore: improve docs clarity #7237
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
"click the to the right of the line number 18" -> "click to the right of the line number 18" The word "the" is extraneous and does not fit grammatically in the sentence. Removing it makes the sentence clearer and more readable.
"with it's own Nargo.toml file" -> "with its own Nargo.toml file" The contraction "it's" stands for "it is" or "it has," while "its" is the possessive form. In this context, "its" is the correct form to indicate possession.
"where the compiled code is execute" -> "where the compiled code is executed" The verb "execute" should be in the past participle form "executed" to match the passive voice construction of the sentence.
"a collection of one of more crates" -> "a collection of one or more crates" The phrase "one of more" is incorrect and should be "one or more" to properly convey the intended meaning.
"the compiler may fails a type check" -> "the compiler may fail a type check" The verb "fail" should be in its base form "fail" rather than "fails" to properly match the context of the sentence.
"specially as you pass them to the" -> "especially as you pass them to the" The word "specially" should be "especially" to correctly convey the intended meaning.
"We just need to click the to the right of the line number 18." -> "We just need to click to the right of the line number 18." The word 'the' is repeated unnecessarily, which makes the sentence awkward. By removing the extra 'the,' the sentence reads more smoothly.
"wether" -> "whether" The word "wether" should be "whether" to correctly convey the intended meaning.
it's own -> its own The phrase "it's" is a contraction of "it is," whereas "its" is a possessive pronoun. In this context, "its own" is correct because it denotes possession.
[recursion reference] is invalid. Changed (noir/standard_library/recursion.mdx) to (../noir/standard_library/recursion.mdx)
|
Thank you for your contribution to the Noir language. Please do not force push to this branch after the Noir team have started review of this PR. Doing so will only delay us merging your PR as we will need to start the review process from scratch. Thanks for your understanding. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I've reviewed all the .md and .mdx files in the repository and fixed typos and grammar errors that clearly altered the meaning and affected the clarity of the documentation.
I also noticed some awkward wording and punctuation but left them unchanged, as they do not significantly affect readability or comprehension.
In the commit message, I briefly explained the corrections and why they were necessary to improve the overall clarity of the documentation.
Hope this helps.
Problem*
Resolves
Summary*
Fix typos and grammar errors
Additional Context
Documentation*
Check one:
PR Checklist*
cargo fmton default settings.