From 1cfce9edc7d71d9b1350c6621e4073ee8eae8d65 Mon Sep 17 00:00:00 2001 From: Rob Syme Date: Wed, 3 Jul 2024 16:00:43 -0400 Subject: [PATCH] Documentation clarification for `failOnDuplicate` and `failOnMismatch` Before this PR, the docs claimed the "default" value for these configuration values was true when strict mode is enabled. In truth, the value is _set_ to `true` when strict mode is enabled (stronger than just the default). --- docs/operator.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/operator.md b/docs/operator.md index 6eab124a35..5a1aebf61b 100644 --- a/docs/operator.md +++ b/docs/operator.md @@ -758,10 +758,10 @@ Available options: : The zero-based index of each item to use as the matching key. Can also be a list of indices, e.g. `by: [0, 2]` (default: `[0]`). `failOnDuplicate` -: When `true`, an error is reported when the operator receives multiple items from the same channel with the same key (default: `true` if {ref}`strict mode ` is enabled, `false` otherwise). +: When `true`, an error is reported when the operator receives multiple items from the same channel with the same key (default: `false`). Value is set to `true` if {ref}`strict mode ` is enabled. `failOnMismatch` -: When `true`, an error is reported when the operator receives an item from one channel for which there no matching item from the other channel (default: `true` if {ref}`strict mode ` is enabled, `false` otherwise). This option cannot be used with `remainder`. +: When `true`, an error is reported when the operator receives an item from one channel for which there no matching item from the other channel (default: `false`). Value is set to `true` if {ref}`strict mode ` is enabled. This option cannot be used with `remainder`. `remainder` : When `true`, unmatched items are emitted at the end, otherwise they are discarded (default: `false`).