Tweak gist docs

mislav · mislav · commit 622317ee89a4 · 2021-02-03T22:39:58.000+01:00
diff --git a/pkg/cmd/gist/delete/delete.go b/pkg/cmd/gist/delete/delete.go
@@ -27,7 +27,7 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co
 	}
 
 	cmd := &cobra.Command{
-		Use:   "delete {<gist ID> | <gist URL>}",
+		Use:   "delete {<id> | <url>}",
 		Short: "Delete a gist",
 		Args:  cmdutil.MinimumArgs(1, "cannot delete: gist argument required"),
 		RunE: func(c *cobra.Command, args []string) error {
diff --git a/pkg/cmd/gist/edit/edit.go b/pkg/cmd/gist/edit/edit.go
@@ -47,7 +47,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
 	}
 
 	cmd := &cobra.Command{
-		Use:   "edit {<gist ID> | <gist URL>}",
+		Use:   "edit {<id> | <url>}",
 		Short: "Edit one of your gists",
 		Args:  cmdutil.MinimumArgs(1, "cannot edit: gist argument required"),
 		RunE: func(c *cobra.Command, args []string) error {
@@ -60,7 +60,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
 			return editRun(&opts)
 		},
 	}
-	cmd.Flags().StringVarP(&opts.Filename, "filename", "f", "", "a specific file to edit")
+	cmd.Flags().StringVarP(&opts.Filename, "filename", "f", "", "Select a file to edit")
 
 	return cmd
 }
diff --git a/pkg/cmd/gist/view/view.go b/pkg/cmd/gist/view/view.go
@@ -33,7 +33,7 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman
 	}
 
 	cmd := &cobra.Command{
-		Use:   "view {<gist id> | <gist url>}",
+		Use:   "view {<id> | <url>}",
 		Short: "View a gist",
 		Args:  cmdutil.MinimumArgs(1, "cannot view: gist argument required"),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -52,7 +52,7 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman
 
 	cmd.Flags().BoolVarP(&opts.Raw, "raw", "r", false, "Print raw instead of rendered gist contents")
 	cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open gist in the browser")
-	cmd.Flags().BoolVarP(&opts.ListFiles, "files", "", false, "Display filenames list from the gist")
+	cmd.Flags().BoolVarP(&opts.ListFiles, "files", "", false, "List file names from the gist")
 	cmd.Flags().StringVarP(&opts.Filename, "filename", "f", "", "Display a single file from the gist")
 
 	return cmd

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func NewCmdDelete(f cmdutil.Factory, runF func(DeleteOptions) error) *cobra.Co`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`cmd := &cobra.Command{`
`30`		`- Use: "delete {<gist ID> \| <gist URL>}",`
	`30`	`+ Use: "delete {<id> \| <url>}",`
`31`	`31`	`Short: "Delete a gist",`
`32`	`32`	`Args: cmdutil.MinimumArgs(1, "cannot delete: gist argument required"),`
`33`	`33`	`RunE: func(c *cobra.Command, args []string) error {`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func NewCmdEdit(f cmdutil.Factory, runF func(EditOptions) error) *cobra.Comman`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`cmd := &cobra.Command{`
`50`		`- Use: "edit {<gist ID> \| <gist URL>}",`
	`50`	`+ Use: "edit {<id> \| <url>}",`
`51`	`51`	`Short: "Edit one of your gists",`
`52`	`52`	`Args: cmdutil.MinimumArgs(1, "cannot edit: gist argument required"),`
`53`	`53`	`RunE: func(c *cobra.Command, args []string) error {`
`@@ -60,7 +60,7 @@ func NewCmdEdit(f cmdutil.Factory, runF func(EditOptions) error) *cobra.Comman`
`60`	`60`	`return editRun(&opts)`
`61`	`61`	`},`
`62`	`62`	`}`
`63`		`- cmd.Flags().StringVarP(&opts.Filename, "filename", "f", "", "a specific file to edit")`
	`63`	`+ cmd.Flags().StringVarP(&opts.Filename, "filename", "f", "", "Select a file to edit")`
`64`	`64`
`65`	`65`	`return cmd`
`66`	`66`	`}`