update help text

This commit is contained in:
filifa 2024-07-19 22:03:45 -05:00
parent 9f528ab4ae
commit 8051308692
3 changed files with 9 additions and 17 deletions

View File

@ -24,11 +24,8 @@ import (
// rootCmd represents the base command when called without any subcommands // rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{ var rootCmd = &cobra.Command{
Use: "mlblive", Use: "mlblive",
Short: "Output data from Major League Baseball's Stats API", Short: "Command line tools for Major League Baseball's Stats API",
Long: `Output data from Major League Baseball's Stats API. Long: `Command line tools for 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.`,
} }
// Execute adds all child commands to the root command and sets flags appropriately. // Execute adds all child commands to the root command and sets flags appropriately.

View File

@ -72,13 +72,8 @@ func schedule(cmd *cobra.Command, args []string) {
// scheduleCmd represents the schedule command // scheduleCmd represents the schedule command
var scheduleCmd = &cobra.Command{ var scheduleCmd = &cobra.Command{
Use: "schedule", Use: "schedule",
Short: "A brief description of your command", Short: "Retrieve daily schedules",
Long: `A longer description that spans multiple lines and likely contains examples Long: `Retrieve a day's schedule for the whole league or a specific team.`,
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, Run: schedule,
} }

View File

@ -92,11 +92,11 @@ func subscribe(cmd *cobra.Command, args []string) {
// subscribeCmd represents the subscribe command // subscribeCmd represents the subscribe command
var subscribeCmd = &cobra.Command{ var subscribeCmd = &cobra.Command{
Use: "subscribe -g [gamePk]", Use: "subscribe -g [gamePk]",
Short: "Output data from Major League Baseball's Stats API", Short: "Output live game data",
Long: `Output data from Major League Baseball's Stats API. Long: `Output live game data.
mlblive will establish a websocket connection with ws.statsapi.mlb.com and Establish a websocket connection with ws.statsapi.mlb.com and output JSON with
output JSON with live updates of a game.`, live updates of a game.`,
Run: subscribe, Run: subscribe,
} }