Update docs

bakdata · Oct 26, 2023 · 9a7352f · 9a7352f
1 parent e0697ff
commit 9a7352f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/docs/docs/user/references/cli-commands.md b/docs/docs/user/references/cli-commands.md
@@ -120,7 +120,7 @@ $ kpops generate [OPTIONS] PIPELINE_PATH [COMPONENTS_MODULE]
 * `--pipeline-base-dir DIRECTORY`: Base directory to the pipelines (default is current working directory)  [env var: KPOPS_PIPELINE_BASE_DIR; default: .]
 * `--defaults DIRECTORY`: Path to defaults folder  [env var: KPOPS_DEFAULT_PATH]
 * `--config FILE`: Path to the config.yaml file  [env var: KPOPS_CONFIG_PATH; default: config.yaml]
-* `--template / --no-template`: Run Helm template  [default: no-template]
+* `--template / --no-template`: Render component templates, e.g. Kubernetes manifest  [default: no-template]
 * `--steps TEXT`: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]
 * `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: include]
 * `--verbose / --no-verbose`: Enable verbose printing  [default: no-verbose]

diff --git a/kpops/cli/main.py b/kpops/cli/main.py
@@ -246,7 +246,10 @@ def generate(
     pipeline_base_dir: Path = BASE_DIR_PATH_OPTION,
     defaults: Optional[Path] = DEFAULT_PATH_OPTION,
     config: Path = CONFIG_PATH_OPTION,
-    template: bool = typer.Option(False, help="Run Helm template"),  # TODO: update docs
+    template: bool = typer.Option(
+        False,
+        help="Render component templates, e.g. Kubernetes manifest",
+    ),
     steps: Optional[str] = PIPELINE_STEPS,
     filter_type: FilterType = FILTER_TYPE,
     verbose: bool = VERBOSE_OPTION,

diff --git a/kpops/components/base_components/pipeline_component.py b/kpops/components/base_components/pipeline_component.py
@@ -188,7 +188,7 @@ def inflate(self) -> list[PipelineComponent]:
         return [self]
 
     def template(self) -> Mapping:
-        """Generate manifest representation, e.g. for Kubernetes."""
+        """Render component template, e.g. Kubernetes manifest."""
         return {}
 
     def deploy(self, dry_run: bool) -> None: