diff --git a/docs/cli-reference/dfx-canister.md b/docs/cli-reference/dfx-canister.md index e1cc963783..dbedc4be29 100644 --- a/docs/cli-reference/dfx-canister.md +++ b/docs/cli-reference/dfx-canister.md @@ -30,7 +30,7 @@ For reference information and examples that illustrate using `dfx canister` comm | [`send`](#dfx-canister-send) | Send a previously-signed message. | | [`sign`](#dfx-canister-send) | Sign a canister call and generate message file. | | [`start`](#dfx-canister-start) | Starts a stopped canister. | -| [`status`](#dfx-canister-status) | Returns the current status of a canister: Running, Stopping, or Stopped. | +| [`status`](#dfx-canister-status) | Returns the current status of a canister as defined [here](https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-canister_status). | | [`stop`](#dfx-canister-stop) | Stops a currently running canister. | | [`uninstall-code`](#dfx-canister-uninstall-code) | Uninstalls a canister, removing its code and state. Does not delete the canister. | | [`update-settings`](#dfx-canister-update-settings) | Update one or more of a canister's settings (i.e its controller, compute allocation, or memory allocation.). | diff --git a/src/dfx/src/commands/canister/status.rs b/src/dfx/src/commands/canister/status.rs index 3401f1cc08..d51e065e3c 100644 --- a/src/dfx/src/commands/canister/status.rs +++ b/src/dfx/src/commands/canister/status.rs @@ -12,7 +12,7 @@ use ic_types::Principal; use slog::info; use std::time::Duration; -/// Returns the current status of a canister: Running, Stopping, or Stopped. +/// Returns the current status of a canister: Running, Stopping, or Stopped. Also carries information like balance, current settings, memory used and everything returned by 'info'. #[derive(Parser)] pub struct CanisterStatusOpts { /// Specifies the name of the canister to return information for.