From 1fd44981797d9908476025573e89bb4963418a78 Mon Sep 17 00:00:00 2001 From: "Joshua A. Anderson" Date: Tue, 20 Aug 2024 08:51:22 -0400 Subject: [PATCH] Update documentation. --- doc/src/workflow/action/group.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/src/workflow/action/group.md b/doc/src/workflow/action/group.md index 40a414b..2b2a588 100644 --- a/doc/src/workflow/action/group.md +++ b/doc/src/workflow/action/group.md @@ -29,9 +29,12 @@ Each selector is a **table** with only one of the following keys: * `condition`: An array of three elements: The *JSON pointer*, *the operator*, and the *operand*. The [JSON pointer](../../guide/concepts/json-pointers.md) references a specific portion of the directory's value. The operator may be `"<"`, `"<="`, - `"=="`, `">="`, or `">"`. + `"=="`, `">="`, or `">"`. Both operands **must** have the same data type. The element + referenced by each JSON pointer must be present in the value of **every** directory. * `all`: Array of conditions (see above). All conditions must be true for this selector - to be true. + to be true. `all` is evaluated with short-circuit logic. When an element in `all` + evaluates to `false`, the JSON pointers in the remaining elements are not evaluated + and are not required to be present. For example, select all directories where a value is in the given range: ```toml @@ -54,10 +57,7 @@ Compare by array: condition = ["/array", "==", [1, "string", 14.0] ``` -Both operands **must** have the same data type. The element referenced by JSON pointer -must be present in the value of **every** directory. -When you omit `include`, **row** includes **all** directories in the workspace. > Note: **Row** compares arrays *lexicographically*. @@ -66,6 +66,8 @@ JSON Objects (also known as maps or dictionaries) are not comparable. You must u pointers to specific keys in objects. +When you omit `include`, **row** includes **all** directories in the workspace. + ## sort_by `action.group.sort_by`: **array** of **strings** - An array of