From d22926ef2e254666d760d1b703c34b30beb6311a Mon Sep 17 00:00:00 2001 From: MichaelVL Date: Fri, 28 Jul 2023 08:28:46 +0200 Subject: [PATCH] Update wording in function name docs --- .../01-declarative-function-execution.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/site/book/04-using-functions/01-declarative-function-execution.md b/site/book/04-using-functions/01-declarative-function-execution.md index 7c67d5d73..89ef91286 100644 --- a/site/book/04-using-functions/01-declarative-function-execution.md +++ b/site/book/04-using-functions/01-declarative-function-execution.md @@ -215,8 +215,8 @@ pipeline: ## Specifying function `name` -Functions can optionally be named to e.g. express the combined effect -of `function` and `functionConfig`. +Functions can optionally be named using the `pipeline.mutators.name` +or `pipeline.validators.name` field to identify a function. For example: @@ -234,11 +234,11 @@ pipeline: tier: mysql ``` -Specifying unique function names for all functions in a `Kptfile` is -highly recommended, since package updates with `kpt pkg update` merges -the `mutator` and `validator` function lists as associative list using -the `name` field to identify functions. An unspecified `name` or -duplicated names may result in unexpected package updates. +Unique function names for all functions in the Kptfile function +pipeline is recommended. If `name` is specified, `kpt pkg update` +will merge each function pipeline list as an associative list, using +`name` as the merge key. An unspecified `name` or duplicated names may +result in unexpected merges. ## Specifying `selectors`