fixed multiple grammatical errors in docs. #1497
Conversation
vyasriday
changed the title
Codecov Report
@@ Coverage Diff @@
## master #1497 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 487 487
Branches 136 136
=========================================
Hits 487 487 Continue to review full report at Codecov.
|
docs/error-handling.md
Outdated
| @@ -52,7 +52,7 @@ app.use(async (ctx, next) => { | |||
|
|
|||
| Error event listeners can be specified with `app.on('error')`. | |||
| If no error listener is specified, a default error listener | |||
| is used. Error listener receive all errors that make their | |||
| is used. Error listener receives all errors that make their | |||
There was a problem hiding this comment.
This should be "Error listeners receive".
There was a problem hiding this comment.
updated with the changes
There was a problem hiding this comment.
Thank you! Any chance you could pull in master branch and rebase? I added myself to list of people receiving vulnerability notifications as @dead-horse mentioned, because I would love to continue to help make sure Koa sticks around for the long term.
There was a problem hiding this comment.
Sure I will rebase and then push the changes. @niftylettuce
vyasriday
force-pushed
the
docs/grammatical_errors
branch
from
915568f
to
68d1314
Compare
docs/guide.md
Outdated
| @@ -98,9 +100,9 @@ function logger(format) { | |||
| } | |||
| ``` | |||
|
|
|||
| ### Combining multiple middleware with koa-compose | |||
| ### Combining multiple middlewares with koa-compose | |||
docs/guide.md
Outdated
|
|
||
| Sometimes you want to "compose" multiple middleware into a single middleware for easy re-use or exporting. You can use [koa-compose](https://github.com/koajs/compose) | ||
| Sometimes you want to "compose" multiple middlewares into a single middleware for easy re-use or exporting. You can use [koa-compose](https://github.com/koajs/compose) |
docs/faq.md
Outdated
| @@ -8,7 +8,7 @@ | |||
| and less error-prone to write, for the entire stack, not | |||
| just the end application code. | |||
|
|
|||
| Typically many middleware would | |||
| Typically many middlewares would | |||
There was a problem hiding this comment.
I disagree, the plural form of middleware is middleware.
There was a problem hiding this comment.
I updated the PR with the changes. I looked middleware and found a debatable answer. Both middleware and middlewares are used. But since middleware is uncountable as per english dictionary, let's use middleware for both singular and plural form moving forward. @niftylettuce what do you say?
docs/faq.md
Outdated
| @@ -23,7 +23,7 @@ | |||
| ## Does Koa include routing? | |||
|
|
|||
| No - out of the box Koa has no form of routing, however | |||
| many routing middleware are available: https://github.com/koajs/koa/wiki | |||
| many routing middlewares are available: https://github.com/koajs/koa/wiki | |||
| @@ -52,7 +52,7 @@ app.use(async (ctx, next) => { | |||
|
|
|||
| Error event listeners can be specified with `app.on('error')`. | |||
| If no error listener is specified, a default error listener | |||
| is used. Error listener receive all errors that make their | |||
| is used. Error listeners receive all errors that make their | |||
There was a problem hiding this comment.
I this case, it describes the function, which is an error listener "type". I would keep this in singular form IMO.
There was a problem hiding this comment.
With respect to line 53 I belive plural form makes more sense.
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| ## Try-Catch | |||
|
|
|||
| Using async functions means that you can try-catch `next`. | |||
| Using async functions mean that you can try-catch `next`. | |||
There was a problem hiding this comment.
I'm not an english native speaker, but I feel it's supposed to be "means" rather than "mean" in this sentence. @niftylettuce What's your take on it?
There was a problem hiding this comment.
Either way works and people will understand
There was a problem hiding this comment.
@miwnwski I believe it should be mean rather than means as per grammar.
vyasriday
force-pushed
the
docs/grammatical_errors
branch
from
68d1314
to
acfc391
Compare
Following files were updated