docs: revise device update --locked arg

Signed-off-by: Marques Johansson <[email protected]>
equinix · Aug 26, 2024 · 67dbcd0 · 67dbcd0
1 parent bef3873
commit 67dbcd0
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/metal_device_update.md b/docs/metal_device_update.md
@@ -7,7 +7,7 @@ Updates a device.
 Updates the hostname of a device. Updates or adds a description, tags, userdata, custom data, and iPXE settings for an already provisioned device. Can also lock or unlock future changes to the device.
 
 ```
-metal device update -i <device_id> [-H <hostname>] [-d <description>] [--locked <boolean>] [-t <tags>] [-u <userdata> | --userdata-file <filepath>] [-c <customdata>] [-s <ipxe_script_url>] [--always-pxe=<true|false>] [flags]
+metal device update -i <device_id> [-H <hostname>] [-d <description>] [--locked=<true|false>] [-t <tags>] [-u <userdata> | --userdata-file <filepath>] [-c <customdata>] [-s <ipxe_script_url>] [--always-pxe=<true|false>] [flags]
 ```
 
 ### Examples

diff --git a/internal/devices/update.go b/internal/devices/update.go
@@ -45,7 +45,7 @@ func (c *Client) Update() *cobra.Command {
 	)
 	// updateDeviceCmd represents the updateDevice command
 	updateDeviceCmd := &cobra.Command{
-		Use:   `update -i <device_id> [-H <hostname>] [-d <description>] [--locked <boolean>] [-t <tags>] [-u <userdata> | --userdata-file <filepath>] [-c <customdata>] [-s <ipxe_script_url>] [--always-pxe=<true|false>]`,
+		Use:   `update -i <device_id> [-H <hostname>] [-d <description>] [--locked=<true|false>] [-t <tags>] [-u <userdata> | --userdata-file <filepath>] [-c <customdata>] [-s <ipxe_script_url>] [--always-pxe=<true|false>]`,
 		Short: "Updates a device.",
 		Long:  "Updates the hostname of a device. Updates or adds a description, tags, userdata, custom data, and iPXE settings for an already provisioned device. Can also lock or unlock future changes to the device.",
 		Example: `  # Updates the hostname of a device: