From d08b7dca8cb704a88d79409fa3932a61d119358d Mon Sep 17 00:00:00 2001 From: Salomon Popp Date: Thu, 26 Oct 2023 17:43:47 +0200 Subject: [PATCH] Update help for `kpops generate` --- docs/docs/user/references/cli-commands.md | 4 ++-- kpops/cli/main.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/user/references/cli-commands.md b/docs/docs/user/references/cli-commands.md index 0ead59916..e7a145d8d 100644 --- a/docs/docs/user/references/cli-commands.md +++ b/docs/docs/user/references/cli-commands.md @@ -18,7 +18,7 @@ $ kpops [OPTIONS] COMMAND [ARGS]... * `clean`: Clean pipeline steps * `deploy`: Deploy pipeline steps * `destroy`: Destroy pipeline steps -* `generate`: Enriches pipelines steps with defaults. +* `generate`: Enrich pipeline steps with defaults. * `render`: In addition to generate, renders final... * `reset`: Reset pipeline steps * `schema`: Generate json schema. @@ -103,7 +103,7 @@ $ kpops destroy [OPTIONS] PIPELINE_PATH [COMPONENTS_MODULE] ## `kpops generate` -Enriches pipelines steps with defaults. The output is used as input for the deploy/destroy/... commands. +Enrich pipeline steps with defaults. The enriched pipeline is used for all KPOps operations (deploy, destroy, ...). **Usage**: diff --git a/kpops/cli/main.py b/kpops/cli/main.py index c0c07658b..ada644e35 100644 --- a/kpops/cli/main.py +++ b/kpops/cli/main.py @@ -237,7 +237,7 @@ def schema( @app.command( # pyright: ignore[reportGeneralTypeIssues] https://github.com/rec/dtyper/issues/8 - help="Enriches pipelines steps with defaults. The output is used as input for the deploy/destroy/... commands." + help="Enrich pipeline steps with defaults. The enriched pipeline is used for all KPOps operations (deploy, destroy, ...)." ) def generate( pipeline_path: Path = PIPELINE_PATH_ARG,