From c9a28bbccb4c84783b2106fe2ef5f3d933fafcef Mon Sep 17 00:00:00 2001 From: Justin Poehnelt Date: Wed, 10 Nov 2021 18:53:29 +0000 Subject: [PATCH] docs: explain difference between update and generate --- openapi_python_client/cli.py | 6 +++++- usage.md | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/openapi_python_client/cli.py b/openapi_python_client/cli.py index 44a069245..17731a0dd 100644 --- a/openapi_python_client/cli.py +++ b/openapi_python_client/cli.py @@ -161,7 +161,11 @@ def update( config_path: Optional[pathlib.Path] = CONFIG_OPTION, fail_on_warning: bool = False, ) -> None: - """Update an existing OpenAPI Client library""" + """Update an existing OpenAPI Client library + + 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. + """ from . import update_existing_client if not url and not path: diff --git a/usage.md b/usage.md index 709534d05..61803ce0a 100644 --- a/usage.md +++ b/usage.md @@ -44,6 +44,8 @@ $ openapi-python-client generate [OPTIONS] Update an existing OpenAPI Client library +> **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`. + **Usage**: ```console