diff --git a/CHANGELOG.md b/CHANGELOG.md index d0cb34db79..72b53882d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,8 @@ fees = record { You can get the fees by `get_config` API on the [BTC Mainnet Canister](https://dashboard.internetcomputer.org/canister/ghsi2-tqaaa-aaaan-aaaca-cai). +### chore: Clarify help text for `--always-assist` + # 0.27.0 ### feat!: remove the 'native' replica diff --git a/docs/cli-reference/dfx-canister.mdx b/docs/cli-reference/dfx-canister.mdx index 86331b4cab..d9193938be 100644 --- a/docs/cli-reference/dfx-canister.mdx +++ b/docs/cli-reference/dfx-canister.mdx @@ -138,6 +138,7 @@ You can use the following options with the `dfx canister call` command. | Option | Description | |-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--always-assist` | Use Candid assist when the arguments are not provided through the command line. | | `--argument-file ` | Specifies the file from which to read the argument to pass to the method. Stdin may be referred to as `-`. | | `--async` | Specifies not to wait for the result of the call to be returned by polling the local development environment. Instead return a response ID. | | `--candid ` | Provide the .did file with which to decode the response. Overrides value from `dfx.json` for project canisters. | @@ -517,6 +518,7 @@ You can use the following options with the `dfx canister install` command. | Option | Description | |------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--always-assist` | Use Candid assist when the arguments are not provided through the command line or dfx.json. | | `--argument ` | Specifies an argument to pass to the canister during installation. | | `--argument-type ` | Specifies the data type for the argument when making the call using an argument [possible values: idl, raw] | | `--argument-file ` | Specifies the file from which to read the argument to pass to the init method. Stdin may be referred to as `-`. | @@ -848,6 +850,7 @@ You can specify the following options for the `dfx canister sign` command. | Option | Description | |----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| `--always-assist` | Use Candid assist when the arguments are not provided through the command line. | | `--argument-file ` | Specifies the file from which to read the argument to pass to the method. Stdin may be referred to as `-`. | | `--expire-after ` | Specifies how long the message will be valid before it expires and cannot be sent. Specify in seconds. If not defined, the default is 300s (5m). | | `--file ` | Specifies the output file name. The default is `message.json`. | diff --git a/docs/cli-reference/dfx-deploy.mdx b/docs/cli-reference/dfx-deploy.mdx index 5f433fb625..c51da10896 100644 --- a/docs/cli-reference/dfx-deploy.mdx +++ b/docs/cli-reference/dfx-deploy.mdx @@ -31,6 +31,7 @@ You can use the following options with the `dfx deploy` command. | `--network ` | Overrides the environment to connect to. By default, the local development environment is used. | | `--playground ` | Alias for `--network playground`. | | `--ic ` | Alias for `--network ic`. | +| `--always-assist` | Use Candid assist when the arguments are not provided through the command line or dfx.json. | | `--argument ` | Specifies an argument to pass to the canister during installation. | | `--argument-type ` | Specifies the data type for the argument when making the call using an argument [possible values: idl, raw] | | `--argument-file ` | Specifies the file from which to read the argument to pass to the init method. Stdin may be referred to as `-`. | diff --git a/src/dfx/src/commands/canister/call.rs b/src/dfx/src/commands/canister/call.rs index 389e67ec81..04dfb964dd 100644 --- a/src/dfx/src/commands/canister/call.rs +++ b/src/dfx/src/commands/canister/call.rs @@ -79,7 +79,7 @@ pub struct CanisterCallOpts { #[arg(long)] candid: Option, - /// Always use Candid assist when the argument types are all optional. + /// Use Candid assist when the arguments are not provided through the command line. #[arg( long, conflicts_with("argument"), diff --git a/src/dfx/src/commands/canister/install.rs b/src/dfx/src/commands/canister/install.rs index 28b7f05438..22276324a6 100644 --- a/src/dfx/src/commands/canister/install.rs +++ b/src/dfx/src/commands/canister/install.rs @@ -64,7 +64,7 @@ pub struct CanisterInstallOpts { #[arg(long)] no_asset_upgrade: bool, - /// Always use Candid assist when the argument types are all optional. + /// Use Candid assist when the arguments are not provided through the command line or dfx.json. #[arg( long, conflicts_with("argument"), diff --git a/src/dfx/src/commands/canister/sign.rs b/src/dfx/src/commands/canister/sign.rs index 58bbc62488..a1b7f175e0 100644 --- a/src/dfx/src/commands/canister/sign.rs +++ b/src/dfx/src/commands/canister/sign.rs @@ -56,7 +56,7 @@ pub struct CanisterSignOpts { #[arg(long, default_value = "message.json")] file: PathBuf, - /// Always use Candid assist when the argument types are all optional. + /// Use Candid assist when the arguments are not provided through the command line. #[arg( long, conflicts_with("argument"), diff --git a/src/dfx/src/commands/deploy.rs b/src/dfx/src/commands/deploy.rs index 0451334eb3..2515eb7d1f 100644 --- a/src/dfx/src/commands/deploy.rs +++ b/src/dfx/src/commands/deploy.rs @@ -103,7 +103,7 @@ pub struct DeployOpts { #[command(flatten)] subnet_selection: SubnetSelectionOpt, - /// Always use Candid assist when the argument types are all optional. + /// Use Candid assist when the arguments are not provided through the command line or dfx.json. #[arg( long, conflicts_with("argument"),