Skip to content

Commit 94b7435

Browse files
committed
chore(wording) Fix grammatical issues in comments
1 parent c250d4c commit 94b7435

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -204,10 +204,9 @@ out of the box with EmberJS.
204204

205205
### errorStackInResponse
206206
Along handleErrors, When true, this option will send the error stack if available within the error
207-
reponse. It will be stored under the `source.stack` key.
207+
response. It will be stored under the `source.stack` key.
208208

209-
**Be careful, this option should never be enabled in production environment. It can propagate some
210-
sensitive datas.**
209+
**Please be careful, this option should never be enabled in a production environment. Doing so can expose sensitive data.**
211210

212211
#### example
213212
```js
@@ -440,9 +439,9 @@ module.exports = function (MyModel) {
440439
```
441440

442441
## Custom Errors
443-
Generic errors respond with a 500, but sometime you want to have a better control over the error that is returned to the client, taking advantages of fields provided by JSONApi.
442+
Generic errors respond with a 500, but sometimes you want to have a better control over the error that is returned to the client, taking advantages of fields provided by JSONApi.
444443

445-
**It is recommanded to extend the base Error constructor, before throwing errors, ex: BadRequestError**
444+
**It is recommended that you extend the base Error constructor before throwing errors. Eg. BadRequestError**
446445

447446
`meta` and `source` fields needs to be objects.
448447

lib/errors.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ function JSONAPIErrorHandler (err, req, res, next) {
130130
* @param {String} errorDetail error message for the user, human readable
131131
* @param {String} errorCode internal system error code
132132
* @param {String} errorName error title for the user, human readable
133-
* @param {String} errorSource Some informations about the source of the issue
134-
* @param {String} errorMeta Some custom metas informations to give to the error response
133+
* @param {String} errorSource Some information about the source of the issue
134+
* @param {String} errorMeta Some custom meta information to give to the error response
135135
* @return {Object}
136136
*/
137137
function buildErrorResponse (

0 commit comments

Comments
 (0)