chore: add description

DanielleMaywood · DanielleMaywood · commit f75f82272dbe · 2025-02-19T10:22:44.000Z
diff --git a/cli/notifications.go b/cli/notifications.go
@@ -23,6 +23,10 @@ func (r *RootCmd) notifications() *serpent.Command {
 				Description: "Resume Coder notifications",
 				Command:     "coder notifications resume",
 			},
+			Example{
+				Description: "Send a test notification. Administrators can use this to verify the notification target settings.",
+				Command:     "coder notifications test",
+			},
 		),
 		Aliases: []string{"notification"},
 		Handler: func(inv *serpent.Invocation) error {
@@ -89,7 +93,7 @@ func (r *RootCmd) testNotifications() *serpent.Command {
 	client := new(codersdk.Client)
 	cmd := &serpent.Command{
 		Use:   "test",
-		Short: "Test notifications",
+		Short: "Send a test notification",
 		Middleware: serpent.Chain(
 			serpent.RequireNArgs(0),
 			r.InitClient(client),
diff --git a/cli/testdata/coder_notifications_--help.golden b/cli/testdata/coder_notifications_--help.golden
@@ -19,11 +19,17 @@ USAGE:
     - Resume Coder notifications:
   
        $ coder notifications resume
+  
+    - Send a test notification. Administrators can use this to verify the
+  notification
+  target settings.:
+  
+       $ coder notifications test
 
 SUBCOMMANDS:
     pause     Pause notifications
     resume    Resume notifications
-    test      Test notifications
+    test      Send a test notification
 
 ———
 Run `coder --help` for a list of global options.
diff --git a/cli/testdata/coder_notifications_test_--help.golden b/cli/testdata/coder_notifications_test_--help.golden
@@ -3,7 +3,7 @@ coder v0.0.0-devel
 USAGE:
   coder notifications test
 
-  Test notifications
+  Send a test notification
 
 ———
 Run `coder --help` for a list of global options.
