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
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.

View File

@ -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() {

View File

@ -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,
}