Skip to content

Commit fc8f17e

Browse files
CopilotEndlessTrax
andauthored
fix: remove todo placeholders from CLI help text (#16)
* Initial plan * fix: remove TODO items from CLI help text - Replace TODO in root command with proper short/long descriptions - Replace TODO in check command with proper short/long descriptions - All descriptions based on README content - Tests passing, code formatted Co-authored-by: EndlessTrax <17141891+EndlessTrax@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: EndlessTrax <17141891+EndlessTrax@users.noreply.github.com>
1 parent 98d7c1b commit fc8f17e

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

cmd/check.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ func init() {
6363

6464
var checkCmd = &cobra.Command{
6565
Use: "check",
66-
Short: "TODO: Add a short description here",
67-
Long: `TODO: Add a longer description here`,
66+
Short: "Check links on a URL or sitemap",
67+
Long: `Check all links on a webpage or sitemap for broken links. Validates HTTP status codes and displays results with color-coded output.`,
6868
Run: func(cmd *cobra.Command, args []string) {
6969
_ = cmd.Help()
7070
},

cmd/root.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ var Version = "0.1.0"
1313
var rootCmd = &cobra.Command{
1414
Use: "brokli",
1515
Version: Version,
16-
Short: "TODO: Add a short description here",
17-
Long: `TODO: Add a longer description here`,
16+
Short: "A fast, concurrent broken link checker for websites and sitemaps",
17+
Long: `Brokli is a CLI tool that helps developers validate all links on a page or sitemap during development. It checks HTTP status codes concurrently and displays results with color-coded output, making it easy to spot broken links before deployment.`,
1818
Run: func(cmd *cobra.Command, args []string) {
1919
// If no subcommand is provided, show help
2020
_ = cmd.Help()

0 commit comments

Comments
 (0)