Skip to content

docs: fix typos and grammar throughout README#2681

Open
monqyClouds wants to merge 1 commit into
typestack:developfrom
monqyClouds:docs/readme-typos-and-grammar
Open

docs: fix typos and grammar throughout README#2681
monqyClouds wants to merge 1 commit into
typestack:developfrom
monqyClouds:docs/readme-typos-and-grammar

Conversation

@monqyClouds
Copy link
Copy Markdown

Summary

12 small wording fixes in README.md. All are spelling typos, missing/wrong articles, missing prepositions, or grammar fixes — no behavior or example semantics are changed.

Where Before After
L105 (code example) 'validation succeed' 'validation succeeded' (matches 'validation failed' above)
L145 "will result unknown objects passing" "will result in unknown objects passing"
L213 "There are few special tokens" "There are a few special tokens"
L402 (code comment) "password wil be validated" "password will be validated"
L531 "result in a unknown value error" "result in an unknown value error"
L578 "an individual validaton decorator to apply conditionally, you can you can use" "an individual validation decorator to apply conditionally, you can use"
L710 "Lets create a decorator called @IsLongerThan" "Let's create a decorator called @IsLongerThan"
L754 "Lets create another custom validation decorator" "Let's create another custom validation decorator"
L790 "it will by async" "it will be async"
L807–808 "Validator supports service container in the case if want ... Here is example how to integrate it" "Validator supports a service container in the case you want ... Here is an example of how to integrate it"
L830 "There are several method exist in the Validator that allows to perform non-decorator based validation" "Several methods are available in the Validator that allow you to perform non-decorator based validation"

How it was tested

Text-only. No anchors changed, no code identifiers touched, no decorator names or method names altered. Reviewed via git diff.

Notes

There are a few more rough spots I left alone (e.g. "Object's property that haven't pass validation" in the ValidationError shape block, "you most probably don't want", "you want not to skip all missing properties") — happy to follow up if a wider sweep is welcome.

- 'validation succeed' -> 'validation succeeded' (match preceding 'failed' tense)
- 'will result unknown' -> 'will result in unknown' (missing preposition)
- 'There are few' -> 'There are a few' (missing article)
- 'wil' -> 'will' (typo in code comment)
- 'a unknown' -> 'an unknown' (wrong article)
- 'validaton' -> 'validation' and remove duplicated 'you can'
- 'Lets create' -> "Let's create" (two occurrences, missing apostrophe)
- 'will by async' -> 'will be async' (typo)
- 'Validator supports service container in the case if want' rewritten
- 'Here is example how to' -> 'Here is an example of how to'
- Rewrite 'There are several method exist in the Validator that allows to perform'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant