fixed typo in developer-docs #1993
Conversation
|
🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. |
Release EnvironmentsThis pull request environment is provided by Release, learn more! 🔧Environment Status : https://app.releasehub.com/public/Processing%20Foundation/env-bccf9ff72b |
|
Many of the .md files in the developer documents folder had punctuation and grammatical errors, which I've fixed. Please review the changes; if any modification is required, I'll be pleased to make them. |
developer_docs/development.md
Outdated
| @@ -87,7 +87,7 @@ Structure your commit message like this: | |||
|
|
|||
| - For common and reusable styles, write OOSCSS (Object-Oriented SCSS) with placeholders and mixins. For organizing styles, follow the [7-1 Pattern](https://sass-guidelin.es/#the-7-1-pattern) for Sass. | |||
|
|
|||
| - We're using [ES6](http://es6-features.org/) and transpiling to ES5 using [Babel](https://babeljs.io/). | |||
| - We're using [ES6](http://es6-features.org/) and transpile to ES5 using [Babel](https://babeljs.io/). | |||
There was a problem hiding this comment.
I think 'transpiling' makes sense here, but could also see this sentence as a whole being rephrased as well!
| @@ -1,12 +1,12 @@ | |||
| # Proposed Public API extensions | |||
|
|
|||
| This describes proposed extensions to the Public API. None of these extensions are confirmed, but are recorded here for reference and discussion. | |||
| This describes proposed extensions to the Public API. None of these extensions is confirmed but is recorded here for reference and discussion. | |||
There was a problem hiding this comment.
I think the verb "are" is referring to "extensions". Since "extensions" is plural, I think "are" could be kept!
developer_docs/testing.md
Outdated
| @@ -485,14 +485,14 @@ afterEach(() => server.resetHandlers()); | |||
| afterAll(() => server.close()); | |||
| ``` | |||
|
|
|||
| If the component makes use of the `formatDate` util, some of the functions in that rely on the `client/i18n.js` file that also makes an AJAX request, which sometimes leads to an `ERRCONNECTED` error on the console, even though your tests pass. You can fix it by adding a mock for that specific i18n file: | |||
| If the component makes use of the `formatDate` util, some of the functions in that rely on the `client/i18n.js` file also make an AJAX request, which sometimes leads to an `ERRCONNECTED` error on the console, even though your tests pass. You can fix it by adding a mock for that specific i18n file: | |||
There was a problem hiding this comment.
I interpreted the updated phrasing to state that the functions themselves are also making an AJAX request, as opposed to the original docs, which I think implies that the client/i8n.js file is making AJAX requests in tandem with the functions.
However, I'm not entirely certain and feel that this entire sentence could possibly be made clearer, let me know what you think!
developer_docs/translations.md
Outdated
| @@ -53,7 +53,7 @@ export function languageKeyToDateLocale(lang) { | |||
|
|
|||
| ## Translations | |||
|
|
|||
| * Every component should introduce its own subset of keys inside a dictionary named after the component. | |||
| * Every component should introduce its subset of keys inside a dictionary named after the component. | |||
There was a problem hiding this comment.
I think the "own" here helps provide emphasis, but could also be replaced with a different word!
Fixes #issue-number
I have verified that this pull request:
npm run lint)developbranch. (If I was asked to make more changes, I have made sure to rebase ontodevelopthen too)Fixes #123