Remove dots from short descriptions

This commit is contained in:
Oscar Utbult
2022-07-22 17:16:43 +02:00
parent 2f2ba40876
commit d96e47cc38
15 changed files with 15 additions and 15 deletions

View File

@@ -11,7 +11,7 @@ import (
func GetCfg(name string) *cobra.Command { func GetCfg(name string) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "cfg", Use: "cfg",
Short: "Commands for reading and writing configuration.", Short: "Commands for reading and writing configuration",
} }
cmd.AddCommand(commands.AnnotateCommand(name)) cmd.AddCommand(commands.AnnotateCommand(name))

View File

@@ -11,7 +11,7 @@ import (
func GetFn(name string) *cobra.Command { func GetFn(name string) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "fn", Use: "fn",
Short: "Commands for running functions against configuration.", Short: "Commands for running functions against configuration",
} }
cmd.AddCommand(commands.RunCommand(name)) cmd.AddCommand(commands.RunCommand(name))

View File

@@ -42,7 +42,7 @@ func MakeHelp(pgmName, cmdName string) *Help {
fN := konfig.DefaultKustomizationFileName() fN := konfig.DefaultKustomizationFileName()
return &Help{ return &Help{
Use: cmdName + " DIR", Use: cmdName + " DIR",
Short: "Build a kustomization target from a directory or URL.", Short: "Build a kustomization target from a directory or URL",
Long: fmt.Sprintf(`Build a set of KRM resources using a '%s' file. Long: fmt.Sprintf(`Build a set of KRM resources using a '%s' file.
The DIR argument must be a path to a directory containing The DIR argument must be a path to a directory containing
'%s', or a git repository URL with a path suffix '%s', or a git repository URL with a path suffix

View File

@@ -204,7 +204,7 @@ func TestHelp(t *testing.T) {
if cmd.Use != "bar DIR" { if cmd.Use != "bar DIR" {
t.Fatalf("Unexpected usage: %s\n", cmd.Use) t.Fatalf("Unexpected usage: %s\n", cmd.Use)
} }
if cmd.Short != "Build a kustomization target from a directory or URL." { if cmd.Short != "Build a kustomization target from a directory or URL" {
t.Fatalf("Unexpected short help: %s\n", cmd.Short) t.Fatalf("Unexpected short help: %s\n", cmd.Short)
} }
if !strings.Contains(cmd.Long, "If DIR is omitted, '.' is assumed.") { if !strings.Contains(cmd.Long, "If DIR is omitted, '.' is assumed.") {

View File

@@ -24,7 +24,7 @@ func newCmdAddComponent(fSys filesys.FileSystem) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "component", Use: "component",
Short: "Add the name of a file containing a component to the kustomization file.", Short: "Add the name of a file containing a component to the kustomization file",
Example: ` Example: `
add component {filepath}`, add component {filepath}`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {

View File

@@ -23,7 +23,7 @@ func newCmdAddGenerator(fSys filesys.FileSystem) *cobra.Command {
var o addGeneratorOptions var o addGeneratorOptions
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "generator", Use: "generator",
Short: "Add the name of a file containing a generator configuration to the kustomization file.", Short: "Add the name of a file containing a generator configuration to the kustomization file",
Example: ` Example: `
add generator {filepath}`, add generator {filepath}`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {

View File

@@ -24,7 +24,7 @@ func newCmdAddPatch(fSys filesys.FileSystem) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "patch", Use: "patch",
Short: "Add an item to patches field.", Short: "Add an item to patches field",
Long: `This command will add an item to patches field in the kustomization file. Long: `This command will add an item to patches field in the kustomization file.
Each item may: Each item may:

View File

@@ -24,7 +24,7 @@ func newCmdAddResource(fSys filesys.FileSystem) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "resource", Use: "resource",
Short: "Add the name of a file containing a resource to the kustomization file.", Short: "Add the name of a file containing a resource to the kustomization file",
Example: ` Example: `
add resource {filepath}`, add resource {filepath}`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {

View File

@@ -23,7 +23,7 @@ func newCmdAddTransformer(fSys filesys.FileSystem) *cobra.Command {
var o addTransformerOptions var o addTransformerOptions
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "transformer", Use: "transformer",
Short: "Add the name of a file containing a transformer configuration to the kustomization file.", Short: "Add the name of a file containing a transformer configuration to the kustomization file",
Example: ` Example: `
add transformer {filepath}`, add transformer {filepath}`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {

View File

@@ -17,7 +17,7 @@ func NewCmdAdd(
rf *resource.Factory) *cobra.Command { rf *resource.Factory) *cobra.Command {
c := &cobra.Command{ c := &cobra.Command{
Use: "add", Use: "add",
Short: "Adds an item to the kustomization file.", Short: "Adds an item to the kustomization file",
Long: "", Long: "",
Example: ` Example: `
# Adds a secret to the kustomization file # Adds a secret to the kustomization file

View File

@@ -20,7 +20,7 @@ func newCmdAddConfigMap(
var flags flagsAndArgs var flags flagsAndArgs
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "configmap NAME [--behavior={create|merge|replace}] [--from-file=[key=]source] [--from-literal=key1=value1]", Use: "configmap NAME [--behavior={create|merge|replace}] [--from-file=[key=]source] [--from-literal=key1=value1]",
Short: "Adds a configmap to the kustomization file.", Short: "Adds a configmap to the kustomization file",
Long: "", Long: "",
Example: ` Example: `
# Adds a configmap to the kustomization file (with a specified key) # Adds a configmap to the kustomization file (with a specified key)

View File

@@ -15,7 +15,7 @@ func NewCmdRemove(
v ifc.Validator) *cobra.Command { v ifc.Validator) *cobra.Command {
c := &cobra.Command{ c := &cobra.Command{
Use: "remove", Use: "remove",
Short: "Removes items from the kustomization file.", Short: "Removes items from the kustomization file",
Long: "", Long: "",
Example: ` Example: `
# Removes resources from the kustomization file # Removes resources from the kustomization file

View File

@@ -13,7 +13,7 @@ import (
func NewCmdSet(fSys filesys.FileSystem, ldr ifc.KvLoader, v ifc.Validator) *cobra.Command { func NewCmdSet(fSys filesys.FileSystem, ldr ifc.KvLoader, v ifc.Validator) *cobra.Command {
c := &cobra.Command{ c := &cobra.Command{
Use: "set", Use: "set",
Short: "Sets the value of different fields in kustomization file.", Short: "Sets the value of different fields in kustomization file",
Long: "", Long: "",
Example: ` Example: `
# Sets the nameprefix field # Sets the nameprefix field

View File

@@ -21,7 +21,7 @@ func newCmdSetNamePrefix(fSys filesys.FileSystem) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "nameprefix", Use: "nameprefix",
Short: "Sets the value of the namePrefix field in the kustomization file.", Short: "Sets the value of the namePrefix field in the kustomization file",
Example: ` Example: `
The command The command
set nameprefix acme- set nameprefix acme-

View File

@@ -21,7 +21,7 @@ func newCmdSetNameSuffix(fSys filesys.FileSystem) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "namesuffix", Use: "namesuffix",
Short: "Sets the value of the nameSuffix field in the kustomization file.", Short: "Sets the value of the nameSuffix field in the kustomization file",
Example: ` Example: `
The command The command
set namesuffix -- -acme set namesuffix -- -acme