From 80513086927f12f97748d1dfa0f5d1eff878b726 Mon Sep 17 00:00:00 2001 From: filifa Date: Fri, 19 Jul 2024 22:03:45 -0500 Subject: [PATCH] update help text --- cmd/root.go | 7 ++----- cmd/schedule.go | 11 +++-------- cmd/subscribe.go | 8 ++++---- 3 files changed, 9 insertions(+), 17 deletions(-) diff --git a/cmd/root.go b/cmd/root.go index 5a1339e..6d6f196 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -24,11 +24,8 @@ import ( // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ Use: "mlblive", - Short: "Output data from Major League Baseball's Stats API", - Long: `Output data from Major League Baseball's Stats API. - -mlblive will establish a websocket connection with ws.statsapi.mlb.com and -output JSON with live updates of a team's game.`, + Short: "Command line tools for Major League Baseball's Stats API", + Long: `Command line tools for Major League Baseball's Stats API.`, } // Execute adds all child commands to the root command and sets flags appropriately. diff --git a/cmd/schedule.go b/cmd/schedule.go index 23b7485..a2a3eb3 100644 --- a/cmd/schedule.go +++ b/cmd/schedule.go @@ -72,14 +72,9 @@ func schedule(cmd *cobra.Command, args []string) { // scheduleCmd represents the schedule command var scheduleCmd = &cobra.Command{ Use: "schedule", - Short: "A brief description of your command", - Long: `A longer description that spans multiple lines and likely contains examples -and usage of using your command. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application.`, - Run: schedule, + Short: "Retrieve daily schedules", + Long: `Retrieve a day's schedule for the whole league or a specific team.`, + Run: schedule, } func init() { diff --git a/cmd/subscribe.go b/cmd/subscribe.go index 97d0489..9b02bc3 100644 --- a/cmd/subscribe.go +++ b/cmd/subscribe.go @@ -92,11 +92,11 @@ func subscribe(cmd *cobra.Command, args []string) { // subscribeCmd represents the subscribe command var subscribeCmd = &cobra.Command{ Use: "subscribe -g [gamePk]", - Short: "Output data from Major League Baseball's Stats API", - Long: `Output data from Major League Baseball's Stats API. + Short: "Output live game data", + Long: `Output live game data. -mlblive will establish a websocket connection with ws.statsapi.mlb.com and -output JSON with live updates of a game.`, +Establish a websocket connection with ws.statsapi.mlb.com and output JSON with +live updates of a game.`, Run: subscribe, }