romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-08-26 00:33:34 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: reduce/avoid English contractions

Browse source 
You're => You are
Hasn't => Has not
Doesn't => Does not
Don't => Do not
You'll => You will
etc

Closes #7930
This commit is contained in:
Daniel Stenberg 2021-10-31 16:34:44 +01:00
parent d3d079c138
commit a28464ae77
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
265 changed files with 926 additions and 925 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/CODE_REVIEW.md
View file

@ -43,10 +43,10 @@ as possible.
## Code style
Most code style nits are detected by checksrc but not all. Only leave remarks
on style deviation once checksrc doesn't find anymore.
on style deviation once checksrc does not find anymore.
Minor nits from fresh submitters can also be handled by the maintainer when
merging, in case it seems like the submitter isn't clear on what to do. We
merging, in case it seems like the submitter is not clear on what to do. We
want to make the process fun and exciting for new contributors.
## Encourage consistency
@ -105,15 +105,15 @@ updated documentation. Submitting that in a separate follow-up pull request is
not OK. A code review must also verify that the submitted documentation update
matches the code submission.
English isn't everyone's first language, be mindful of this and help the
English is not everyone's first language, be mindful of this and help the
submitter improve the text if it needs a rewrite to read better.
## Code shouldn't be hard to understand
## Code should not be hard to understand
Source code should be written to maximize readability and be easy to
understand.
## Functions shouldn't be large
## Functions should not be large
A single function should never be large as that makes it hard to follow and
understand all the exit points and state changes. Some existing functions in