Skip to content

Commit

Permalink
chore(repo): fix documentation typos
Browse files Browse the repository at this point in the history
  • Loading branch information
frankkilcommins committed Oct 16, 2024
1 parent 8705ae7 commit 63fa1f8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
-o /var/tmp/php_api_client
```

**Note:** if you're on Windows, replace the last command with
**Note:** if you're on Windows, replace the last command with:

```sh
java -jar modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i http://petstore.swagger.io/v2/swagger.json -l php -o c:\temp\php_api_client
Expand All @@ -134,7 +134,7 @@ To get a list of **general** options available, please run:
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate --help
```

To get a list of PHP specified options (which can be passed to the generator with a config file via the `-c` option), please run
To get a list of PHP specified options (which can be passed to the generator with a config file via the `-c` option), please run:

```sh
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l php
Expand All @@ -161,7 +161,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
-o samples/client/petstore/java # The output destination.
```

with a number of options. You can get the options with the `generate --help` command (below only shows partial results):
You can get the options with the `generate --help` command (below only shows partial results):

```text
NAME
Expand Down Expand Up @@ -291,8 +291,8 @@ The Swagger Codegen project is intended as a benefit for users of the Swagger /
- The templates included with this project are subject to the [License](./LICENSE).
- Generated code is intentionally _not_ subject to the parent project license

When code is generated from this project, it shall be considered **AS IS** and owned by the user of the software. There are no warranties--expressed or implied--for generated code. You can do what you wish with it, and once generated, the code is your responsibility and subject to the licensing terms that you deem appropriate.
When code is generated from this project, it shall be considered **AS IS** and owned by the user of the software. There are no warranties, expressed or implied, for generated code. You can do what you wish with it, and once generated, the code is your responsibility and subject to the licensing terms that you deem appropriate.

## Thank You

💚💚💚 We'd like to give a big shout our to all those who've contributed to Swagger Codegen, be that in raising issues, fixing bugs, authoring templates, or crafting useful content for others to benefit from. 💚💚💚
💚💚💚 We'd like to give a big shout out to all those who've contributed to Swagger Codegen, be that in raising issues, fixing bugs, authoring templates, or crafting useful content for others to benefit from. 💚💚💚
4 changes: 2 additions & 2 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ cd /vagrant

- [Official web service](https://hub.docker.com/r/swaggerapi/swagger-generator-v3/)
- [Official web service with "standard" user](https://hub.docker.com/r/swaggerapi/swagger-generator-v3-root/)
- [official minimal web service](https://hub.docker.com/r/swaggerapi/swagger-generator-v3-minimal/)
- [official CLI](https://hub.docker.com/r/swaggerapi/swagger-codegen-cli-v3/)
- [Official minimal web service](https://hub.docker.com/r/swaggerapi/swagger-generator-v3-minimal/)
- [Official CLI](https://hub.docker.com/r/swaggerapi/swagger-codegen-cli-v3/)

### Swagger Generator Docker Image

Expand Down
3 changes: 2 additions & 1 deletion docs/generators-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ and `config.json` contains the following as an example:
```

Supported config options can be different per language. Running `config-help -l {lang}` will show available options.
**These options are applied via configuration file (e.g. config.json) or by passing them with `-D{optionName}={optionValue}`**. (If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it)
**These options are applied via configuration file (e.g. config.json) or by passing them with `-D{optionName}={optionValue}`**.
> If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it.
```sh
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java
Expand Down

0 comments on commit 63fa1f8

Please sign in to comment.