Skip to content

Commit 6eedb2c

Browse files
authored
Fix typos and linguistic errors in documentation (#807)
Signed-off-by: Sebastien Dionne <survivant00@gmail.com>
1 parent 148efb5 commit 6eedb2c

File tree

8 files changed

+10
-10
lines changed

8 files changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ It is not required but highly suggested that you create unit tests for the code
3232

3333
### Tips
3434
- Smaller changes are easier to review
35-
- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
35+
- [Optional] For bug fixes, provide an OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
3636
- Add test case(s) to cover the change
3737
- Make sure test cases passed after the change. All tests run after a PR is created or modified.
38-
- File a PR with meaningful title, description and commit messages.
38+
- File a PR with a meaningful title, description and commit messages.
3939
- To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The options file is described in json (example in `specs/options.json`), and has
128128
|schemaNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`PascalCase`|Naming convention for schemas|
129129
|propertyNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`CamelCase`|Naming convention for properties|
130130
|enumNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`AnyCase`|Naming convention for enums|
131-
|allowedModelProperties|array| `["_links", "_embedded"]`|`[]`|An array of property names that are authorised even if they do not match to the "propertyNamingConvention"|
131+
|allowedModelProperties|array| `["_links", "_embedded"]`|`[]`|An array of property names that are authorized even if they do not match to the "propertyNamingConvention"|
132132

133133
#### Parameter Naming Convention hierarchy
134134

cli/src/main/java/org/openapitools/openapistylevalidator/cli/OutputUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ void printHelp(final Options options, final String cmdLineSyntax) {
2828
options,
2929
HelpFormatter.DEFAULT_LEFT_PAD,
3030
HelpFormatter.DEFAULT_DESC_PAD,
31-
"Thanks for using OpenAPI Style Validator! If you this project useful, consider buying us a tree here: https://ecologi.com/darkjaff",
31+
"Thanks for using OpenAPI Style Validator! If you find this project useful, consider buying us a tree here: https://ecologi.com/darkjaff",
3232
true);
3333

3434
printWriter.flush();

docs/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ It is not required but highly suggested that you create unit tests for the code
3636

3737
### Tips
3838
- Smaller changes are easier to review
39-
- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
39+
- [Optional] For bug fixes, provide an OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
4040
- Add test case(s) to cover the change
4141
- Make sure test cases passed after the change. All tests run after a PR is created or modified.
42-
- File a PR with meaningful title, description and commit messages.
42+
- File a PR with a meaningful title, description and commit messages.
4343
- To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "FAQ: General"
55

66
## Do you have a chat room?
77

8-
[![Jion the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM)
8+
[![Join the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM)
99

1010
## What is the governance structure of the OpenAPI Style Validator project?
1111

gradle-plugin/src/main/java/org/openapitools/openapistylevalidator/gradle/OpenAPIStyleValidatorTask.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public class OpenAPIStyleValidatorTask extends DefaultTask {
4747

4848
public OpenAPIStyleValidatorTask() {
4949
this.setGroup("Verification");
50-
this.setDescription("Validate that OpenAPI files against style rules");
50+
this.setDescription("Validate OpenAPI files against style rules");
5151
}
5252

5353
@TaskAction

website/src/pages/team.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
44
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
55
import styles from './styles.module.css';
66

7-
// This is based mostly off of Babel's website configuration for Members/orgs/etc.
7+
// This is based mostly on Babel's website configuration for Members/orgs/etc.
88
function MediaLink(props) {
99
if (props.text) {
1010
return (

website/src/pages/users.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ function Users() {
1313
const {users = {}} = siteConfig.customFields;
1414

1515
let showcase = users.map((user, idx) => {
16-
// avoid joining base/ with /img/path as double-slash breaks image load.
16+
// Avoid joining base/ with /img/path as a double-slash breaks image load.
1717
let trimmedImg = user.image.startsWith("/") ? user.image.slice(1, user.image.length) : user.image;
1818
let imgUrl = useBaseUrl(trimmedImg);
1919
return (

0 commit comments

Comments
 (0)