Skip to content

Commit

Permalink
Update wording in function name docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelvl committed Jul 28, 2023
1 parent ef72932 commit d22926e
Showing 1 changed file with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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`

Expand Down

0 comments on commit d22926e

Please sign in to comment.