Skip to content

Commit

Permalink
correct parameter description (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
stiebels authored Jul 28, 2023
1 parent c169d02 commit c81eb7d
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ The following workflow generates a PlantUML diagram from the Python module `test
in the `tests` directory and exports it as PUML file as well as SVG to the `diagrams` directory.
Subsequently, the changed files are committed and pushed to the repository.

Note that passing of the parameters `puml_version` as well as `py2puml_version` is optional and both default to `latest`. However, it's recommended to pin down their versions.
```yaml
name: My workflow
on:
Expand Down Expand Up @@ -51,7 +50,7 @@ jobs:
- See [here](https://github.com/lucsorel/py2puml#cli) for a clear explanation on `path` and `module`, following the definition of `py2puml`.
```yaml
puml_version:
description: PlantUML software version
description: PlantUML software version. Whereas it defaults to "latest", it's recommended to pin down the PlantUML version.
default: "latest"
required: true
pip_install_deps_cmd:
Expand Down

0 comments on commit c81eb7d

Please sign in to comment.