Skip to content

Commit

Permalink
Standardize on Return value instead of values
Browse files Browse the repository at this point in the history
  • Loading branch information
lsgunnlsgunn committed Feb 6, 2025
1 parent d5b1ea0 commit b9c305d
Show file tree
Hide file tree
Showing 56 changed files with 56 additions and 56 deletions.
2 changes: 1 addition & 1 deletion docs/builtins/Capabilities/compose-capability.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use the following argument to specify the `CAPABILITY` for the `compose-capabili
| --- | --- | --- |
| `CAPABILITY` | capability | Specifies the capability to include in the scope of an outer capability. |

### Return values
### Return value

The `compose-capability` function returns a boolean value to indicate success or failure in requesting the grant of the specified `CAPABILITY`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Capabilities/emit-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Use the following argument to specify the `CAPABILITY` for the `emit-event` Pact
|------------|------|---------------------------------------------------|
| `CAPABILITY` | capability | Specifies the capability to emit as an event. |

### Return values
### Return value

The `emit-event` function returns a boolean value indicating success or failure of emitting the event.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Commitments/decrypt-cc20p1305.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following arguments to specify the inputs for the `decrypt-cc20p1305` Pa
| `public-key` | `string` | Specifies the base-16 Curve25519 public key. |
| `secret-key` | `string` | Specifies the base-16 Curve25519 secret key. |

### Return values
### Return value

The `decrypt-cc20p1305` function returns the decrypted plaintext as an unpadded base64URL string.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/create-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the following argument to specify the `table` name you want to create using
| --- | --- | --- |
| `table` | `table: <{row}>` | Specifies the table to create. |

### Return values
### Return value

The `create-table` function returns a string representing the identifier of the created `table`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/describe-keyset.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following argument to specify the keyset for which to retrieve metadata
| --- | --- | --- |
| `keyset` | string | Specifies the name of the keyset that you want to retrieve metadata for. |

### Return values
### Return value

The `describe-keyset` function returns a guard.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/describe-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Use the following argument to specify the `module` for the `describe-module` Pac
|----------|--------|----------------------------------------------|
| `module` | string | Specifies the name of the module to describe.|

### Return values
### Return value

The `describe-module` function returns an object with metadata for the specified `module`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/describe-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use the following argument to specify the `table` for the `describe-table` Pact
|----------|---------------|----------------------------------------------|
| `table` | `table: <{row}>` | Specifies the table to describe. |

### Return values
### Return value

The `describe-table` function returns an object with metadata for the specified `table`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/fold-db.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Use the following arguments to specify the table, predicate, and consumer functi
| `query` | `a:string b:object: <{row}>` | Specifies the predicate function to apply to each row and return a boolean value. |
| `consumer` | function with `key: string` and `value: object: <{row}>` | Specifies the consumer function used to accumulate results from each row and return the final result from all accumulated results. |

### Return values
### Return value

The `fold-db` function returns a list of accumulated results based on the predicate `query` and the `consumer` function.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the following argument to specify the table from which to retrieve keys usin
| --- | --- | --- |
| `table` | `table: <{row}>` | Specifies the table from which to retrieve keys. In the table schema, a `row` represents the structure of each row in the table. |

### Return values
### Return value

The `keys` function returns an array of strings, where each string represents a key in the specified table.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/list-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To list all modules in `/local`, use

None

### Return values
### Return value

The `list-modules` function returns a list of all module names (including their namespace) stored on-chain

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Database/read.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Use the following arguments to specify the table, key, and optional columns when
| `key` | string | Specifies the key of the row to read from the table. |
| `columns` | [string] | Specifies one or more column names to return from the row. If not provided, the entire row is returned (optional). |

### Return values
### Return value

The `read` function returns an object representing the requested row or columns from the specified table.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/acquire-module-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It will attempt to acquire the governance cap and if successful, it will grant m
| -------- | ---- | -----------
| `ref` | modref | Specifies the module to acquire administrative capabilities for.

### Return values
### Return value

Module admin acquisition will either fail, or return "Module admin for module `<my-module>` acquired"

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/at.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Use one of the following argument to define the value you want to retrieve using
| `key` | string | Specifies the information you want to retrieve. If you specify a `key` string, the function returns the value corresponding to that key from an object.
| `object` | object | Specifies the set of key and value pairs to retrieve the value from using the specified `key`.

### Return values
### Return value

The `at` function returns the value found at the specified `index` or using the specified `key`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/base64-decode.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the following argument to specify the `string` to decode using the `base64-d
| --- | --- | --- |
| `string` | string | Specifies the base64-encoded `string` to decode. |

### Return values
### Return value

The `base64-decode` function returns the decoded `string`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/base64-encode.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the following argument to specify the `string` to encode using the `base64-e
| --- | --- | --- |
| `string` | string | Specifies the `string` to encode as unpadded base64. |

### Return values
### Return value

The `base64-encode` function returns the unpadded base64 encoded `string`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/bind.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use the following arguments to specify the `src` object and `bindings` for the `
| `src` | `object:{row}` | Specifies the source object to evaluate. |
| `bindings` | `binding:{row}` | Specifies the bindings to apply to the `src` object. |

### Return values
### Return value

The `bind` returns the result of evaluating the `src` object with the specifies `bindings`.
The data type depends on the data type of the field you specify for the `bindings` argument.
Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/chain-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To retrieve the public metadata for a transaction using `chain-data`, use the fo

You can use the `chain-data` function without arguments in code that identifies the transaction that you want to return metadata for.

### Return values
### Return value

The `chain-data` function returns the public metadata for a transaction as an object with the following fields

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the following arguments to specify the functions `oper1` and `oper2` for com
| `oper2` | function: `<b> -> <c>` | Specifies the second function to operate on the results of the `oper1` function. |
| `value` | `<a>` | Specifies the value on which `oper1` operates. |

### Return values
### Return value

The `compose` function returns the result of applying `oper2` to the result returned by `oper1` for the specified `value`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/concat.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the following argument to specify the list of strings `str-list` for the `co
| --- | --- | --- |
| `str-list` | [string] | Specifies the list of strings to concatenate. |

### Return values
### Return value

The `concat` function returns the resulting string after concatenating all the strings in the `str-list`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/constantly.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use the following arguments to specify the `value` to return and the `ignore` ar
| `value` | any | Specifies the value to return. |
| `ignore1, ignore2, ...` | any | Specifies the arguments to ignore. You can have multiple ignore arguments (optional). |

### Return values
### Return value

The `constantly` function returns the specified `value`, ignoring any additional arguments.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/contains.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Use the following arguments to specify the `value`, `list`, `key`, `object`, `st
| `object` | object | Specifies the object to check for the specified `key`. |
| `string` | string | Specifies the string to search for the specified `value`. |

### Return values
### Return value

The `contains` function returns a boolean value indicating whether the specified `value` or the specified `key` was found.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/continue.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following argument to specify the `value` to continue the nested `defpac
| --- | --- | --- |
| `value` | `any` | Specifies the value to continue the nested `defpact`. |

### Return values
### Return value

The `continue` function continues the execution of the nested `defpact` with the specified `value`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/describe-namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the following argument to specify the `namespace` for the `describe-namespac
|----------|--------|---------------------------------------------|
| `namespace` | string | Specifies the name of the namespace to describe.|

### Return values
### Return value

The `describe-namespace` function returns an object with detailed information about the specified `namespace`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/distinct.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use the following argument to specify the list of `VALUES` for the `distinct` Pa
|----------|-------------|------------------------------------------------|
| `values` | [any] | Specifies the list of values that includes duplicates. |

### Return values
### Return value

The `distinct` function returns a list with duplicates removed from the specified list of `values`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/drop.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Use the following arguments to specify the `count` and `list` or `keys` and `ob
| `keys` | [string] | Specifies the keys to drop from the object. |
| `object` | object | Specifies the object from which to drop entries with specified keys.|

### Return values
### Return value

The `drop` function returns the modified list, string, or object after removing the specified number of values or specified keys.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/enforce-guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Use the following arguments to specify the `guard` or `keysetname` for the `enfo
| `guard` | guard | Specifies the name of the guard to execute. |
| `keysetname` | string | Specifies the name of the defined keyset to enforce.|

### Return values
### Return value

The `enforce-guard` function returns a boolean value indicating whether the conditions specified in the predicate logic that the guard or keyset is there to enforce were met.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/enforce-one.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following arguments to specify the error message and tests for the `enfo
| `msg` | string | Specifies the error message if all tests fail. |
| `tests` | bool | Specifies the list of tests to run in order. |

### Return values
### Return value

The `enforce-one` function returns `true` if at least one test succeeds.
If all tests fail, the function fails the transaction with the specified error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/enforce-pact-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Use the following arguments to specify the minimum and maximum Pact versions for
| `min-version` | string | Specifies the minimum Pact version to enforce. |
| `max-version` | string | Specifies the maximum Pact version to enforce (optional). |

### Return values
### Return value

The `enforce-pact-version` function returns a boolean value indicating whether the runtime Pact version is within the specified range.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/enforce-verifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the following argument to specify the `verifier-name` for the `enforce-verif
|-------------|--------|-------------------------------------------------|
| `verifier-name` | string | Specifies the name of the verifier to enforce. |

### Return values
### Return value

The `enforce-verifier` function returns a boolean value indicating whether the specified verifier is in scope.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/enforce.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Use the following arguments to specify the test expression and error message for
| expression | bool | Specifies the expression to evaluate. |
| `message` | string | Specifies the error message to display if the `expression` evaluates as false. |

### Return values
### Return value

The `enforce` function returns `true` if the specified `expression` is true. If the `expression` is false, the function fails the transaction with the specified error message.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/enumerate.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Use the following option to define the increment to use between the beginning an
| --- | --- | --- |
| `inc` | `integer` | Specifies the increment to use between numbers in the sequence. The value can be a positive or negative integer. |

### Return values
### Return value

The `enumerate` function returns the resulting sequence of numbers as a list.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the following arguments to specify the function and list for the `filter` Pa
| `apply` | function | Specifies the function to apply to each element of the list. The return value for the function must be a Boolean (`true` or `false`) to identify elements to be included in the resulting list. |
| `elements` | [any] | Specifies the list of elements to filter. The elements in the list can be any data type. |

### Return values
### Return value

The `filter` function returns a new list containing elements from the original list for which the `apply` function returns `true`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/fold.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the following arguments to specify the function, initial value, and list for
| `init` | `<a>` | Specifies the initial value for the reduction. |
| `list` | [`<b>`] | Specifies the list to iterate over. |

### Return values
### Return value

The `fold` function returns the final result of the iterative reduction of the list.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/format.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use the following arguments to specify the template string and variables for the
| `template` | string | Specifies the template string with `{}` placeholders. |
| `variables` | [any] | Specifies the variables to insert into the template placeholders. |

### Return values
### Return value

The `format` function returns a new string with the values from the specified variables replacing the placeholder curly braces `{}` from the template string.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/hash-keccak256.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Use the following argument to specify the list of inputs for the `hash-keccak256
|-----------|------------|---------------------------------------------------|
| `VALUES` | `[string]` | Specifies the list of unpadded base64url-encoded inputs. |

### Return values
### Return value

The `hash-keccak256` function returns a string representing the computed hash value.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Use the following argument to specify the value for the `hash` Pact function:
|-----------|--------|-------------|
| `value` | `<a>` | Specifies the value to be hashed. |

### Return values
### Return value

The `hash` function returns a string representing the computed hash value.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/General/static-redeploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Use the following argument to specify the module you want to redeploy using the
| -------- | ---- | -----------
| `module` | string | Specifies the module to redeploy.

### Return values
### Return value

The function returns the unit value `()` if redeployment is successful.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Guards/create-capability-guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following argument to specify the `CAPABILITY` for the `create-capabilit
| --- | --- | --- |
| `CAPABILITY` | capability | Specifies the capability that the predicate function guards. |

### Return values
### Return value

The `create-capability-guard` function returns a guard that enforces the acquisition of the specified `CAPABILITY`.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Guards/create-capability-pact-guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following argument to specify the `CAPABILITY` for the `create-capabilit
| --- | --- | --- |
| `CAPABILITY` | capability | Specifies the capability that the predicate function guards. |

### Return values
### Return value

The `create-capability-pact-guard` function returns a guard that enables the code associated with the specified `CAPABILITY` to be executed in the context of a `defpact` multi-step transaction.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Guards/create-module-guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following argument to specify the `name` for the `create-module-guard` P
| --- | --- | --- |
| `name` | string | Specifies the name of the predicate function that guards administrative activity for the current module. |

### Return values
### Return value

The `create-module-guard` function returns a guard with the specified `name`that enables the current module to perform administrative operations.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Guards/create-pact-guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Use the following argument to specify the `name` for the `create-pact-guard` Pac
| --- | --- | --- |
| `name` | string | Specifies the name of the predicate function that captures the `pact-id` for a `defpact` multi-step transaction. |

### Return values
### Return value

The `create-pact-guard` function returns a guard with the specified `name` that captures the `pact-id'` for a `defpact` multi-step transaction.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Guards/create-principal.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Use the following argument to specify the `guard` for the `create-principal` Pac
| --- | --- | --- |
| `guard` | guard | Specifies the guard for which to create a principal. |

### Return values
### Return value

The `create-principal` function returns a string representing a principal that unambiguously identifies the specified `guard` predicate function.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Guards/create-user-guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the following argument to specify the `closure` for the `create-user-guard`
| --- | --- | --- |
| `closure` | closure | Specifies the custom guard closure to define. The closure is a function that takes no arguments and returns a boolean value. |

### Return values
### Return value

The `create-user-guard` function returns a guard that uses the specified custom `closure` function that returns a boolean value.

Expand Down
2 changes: 1 addition & 1 deletion docs/builtins/Keysets/define-keyset.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Use the following arguments to specify the inputs for the `define-keyset` Pact f
| `name` | string | Specifies the name of the keyset to define or read. |
| `keyset` | string | Specifies the keyset to associate with the `name`. |

### Return values
### Return value

The `define-keyset` function returns a string representing the result of defining the keyset.

Expand Down
Loading

0 comments on commit b9c305d

Please sign in to comment.