Skip to content

Commit ccf1fab

Browse files
authored
docs: explain difference between update and generate (#536)
1 parent 1c5110c commit ccf1fab

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

Diff for: openapi_python_client/cli.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,11 @@ def update(
161161
config_path: Optional[pathlib.Path] = CONFIG_OPTION,
162162
fail_on_warning: bool = False,
163163
) -> None:
164-
"""Update an existing OpenAPI Client library"""
164+
"""Update an existing OpenAPI Client library
165+
166+
The update command performs the same operations as generate except it does not overwrite specific metadata for the
167+
generated client such as the README.md, .gitignore, and pyproject.toml.
168+
"""
165169
from . import update_existing_client
166170

167171
if not url and not path:

Diff for: usage.md

+2
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ $ openapi-python-client generate [OPTIONS]
4444

4545
Update an existing OpenAPI Client library
4646

47+
> **Note:** The `update` command performs the same operations as `generate` except it does not overwrite specific metadata for the generated client such as the `README.md`, `.gitignore`, and `pyproject.toml`.
48+
4749
**Usage**:
4850

4951
```console

0 commit comments

Comments
 (0)