Update pubsub Documentation

ForceCLI · Apr 18, 2023 · ab5ec4f · ab5ec4f
1 parent 510f263
commit ab5ec4f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/command/pubsub.go b/command/pubsub.go
@@ -22,6 +22,8 @@ func init() {
 
 var pubsubCmd = &cobra.Command{
 	Use:                   "pubsub subscribe [channel]",
+	Short:                 "Subscribe to a pub/sub channel",
+	Long:                  "Subscribe to a pub/sub channel to stream Change Data Capture or custom Platform Events",
 	DisableFlagsInUseLine: true,
 }
 

diff --git a/docs/force.md b/docs/force.md
@@ -39,7 +39,7 @@ force
 * [force open](force_open.md)	 - Open a browser window, logged into an authenticated Salesforce org
 * [force package](force_package.md)	 - Manage installed packages
 * [force password](force_password.md)	 - See password status or reset password
-* [force pubsub](force_pubsub.md)	 - 
+* [force pubsub](force_pubsub.md)	 - Subscribe to a pub/sub channel
 * [force push](force_push.md)	 - Deploy metadata from a local directory
 * [force query](force_query.md)	 - Execute a SOQL statement
 * [force quickdeploy](force_quickdeploy.md)	 - Quick deploy validation id

diff --git a/docs/force_pubsub.md b/docs/force_pubsub.md
@@ -1,6 +1,10 @@
 ## force pubsub
 
+Subscribe to a pub/sub channel
 
+### Synopsis
+
+Subscribe to a pub/sub channel to stream Change Data Capture or custom Platform Events
 
 ### Options
 

diff --git a/docs/force_pubsub_subscribe.md b/docs/force_pubsub_subscribe.md
@@ -42,5 +42,5 @@ force pubsub subscribe [channel] [flags]
 
 ### SEE ALSO
 
-* [force pubsub](force_pubsub.md)	 - 
+* [force pubsub](force_pubsub.md)	 - Subscribe to a pub/sub channel
Original file line number	Diff line number	Diff line change
Expand Up		@@ -42,5 +42,5 @@ force pubsub subscribe [channel] [flags]

		### SEE ALSO

		* [force pubsub](force_pubsub.md) -
		* [force pubsub](force_pubsub.md) - Subscribe to a pub/sub channel