From 661ae70fd03fb1387deceba46dea5b40341b2762 Mon Sep 17 00:00:00 2001 From: bijayasharma Date: Tue, 26 Jan 2021 14:08:58 -0500 Subject: [PATCH] Removed capitalization in Error string message * This commit will removed capitalizaion in Error message and follow the Golang code rule. * Golang errors should not begin with capitalization: https://github.com/golang/go/wiki/CodeReviewComments#error-strings Signed-off-by: bijayasharma Change-Id: I053cfa9e21ad56b0f30e476ec36320cb7cea4da4 --- cmd/secret/generate/encryptionkey/encryptionkey.go | 2 +- cmd/secret/generate/encryptionkey/encryptionkey_test.go | 2 +- .../generate-encryptionkey-cmd-error.golden | 2 +- docs/source/cli/airshipctl_image_build.md | 2 +- docs/source/cli/airshipctl_phase_run.md | 1 + pkg/document/plugin/templater/templater.go | 2 +- pkg/events/printers_test.go | 4 ++-- pkg/k8s/kubeconfig/kubeconfig_test.go | 6 +++--- 8 files changed, 11 insertions(+), 10 deletions(-) diff --git a/cmd/secret/generate/encryptionkey/encryptionkey.go b/cmd/secret/generate/encryptionkey/encryptionkey.go index a32b41b08..555a5440b 100644 --- a/cmd/secret/generate/encryptionkey/encryptionkey.go +++ b/cmd/secret/generate/encryptionkey/encryptionkey.go @@ -52,7 +52,7 @@ func NewGenerateEncryptionKeyCommand() *cobra.Command { Example: cmdExample, RunE: func(cmd *cobra.Command, args []string) error { if cmd.Flags().Changed("limit") && !cmd.Flags().Changed("regex") { - return fmt.Errorf("Required Regex flag with limit option") + return fmt.Errorf("required Regex flag with limit option") } if cmd.Flags().Changed("regex") && cmd.Flags().Changed("limit") { return errors.ErrNotImplemented{What: "Regex support not implemented yet!"} diff --git a/cmd/secret/generate/encryptionkey/encryptionkey_test.go b/cmd/secret/generate/encryptionkey/encryptionkey_test.go index bb4b0466b..090a278b4 100644 --- a/cmd/secret/generate/encryptionkey/encryptionkey_test.go +++ b/cmd/secret/generate/encryptionkey/encryptionkey_test.go @@ -32,7 +32,7 @@ func TestGenerateEncryptionKey(t *testing.T) { { Name: "generate-encryptionkey-cmd-error", CmdLine: "--limit 10", - Error: fmt.Errorf("Required Regex flag with limit option"), + Error: fmt.Errorf("required Regex flag with limit option"), Cmd: encryptionkey.NewGenerateEncryptionKeyCommand(), }, } diff --git a/cmd/secret/generate/encryptionkey/testdata/TestGenerateEncryptionKeyGoldenOutput/generate-encryptionkey-cmd-error.golden b/cmd/secret/generate/encryptionkey/testdata/TestGenerateEncryptionKeyGoldenOutput/generate-encryptionkey-cmd-error.golden index e4c8e1810..0ec98aedb 100644 --- a/cmd/secret/generate/encryptionkey/testdata/TestGenerateEncryptionKeyGoldenOutput/generate-encryptionkey-cmd-error.golden +++ b/cmd/secret/generate/encryptionkey/testdata/TestGenerateEncryptionKeyGoldenOutput/generate-encryptionkey-cmd-error.golden @@ -1,4 +1,4 @@ -Error: Required Regex flag with limit option +Error: required Regex flag with limit option Usage: encryptionkey [flags] diff --git a/docs/source/cli/airshipctl_image_build.md b/docs/source/cli/airshipctl_image_build.md index ae76310c5..a243292a9 100644 --- a/docs/source/cli/airshipctl_image_build.md +++ b/docs/source/cli/airshipctl_image_build.md @@ -13,7 +13,7 @@ airshipctl image build [flags] ### Options ``` - -h, --help help for build + -h, --help help for build ``` ### Options inherited from parent commands diff --git a/docs/source/cli/airshipctl_phase_run.md b/docs/source/cli/airshipctl_phase_run.md index 0ff629f96..9c0fdb081 100644 --- a/docs/source/cli/airshipctl_phase_run.md +++ b/docs/source/cli/airshipctl_phase_run.md @@ -25,6 +25,7 @@ airshipctl phase run ephemeral-control-plane --dry-run simulate phase execution -h, --help help for run --kubeconfig string Path to kubeconfig associated with site being managed + --progress show progress --wait-timeout duration wait timeout ``` diff --git a/pkg/document/plugin/templater/templater.go b/pkg/document/plugin/templater/templater.go index 33ff131de..4520150f1 100644 --- a/pkg/document/plugin/templater/templater.go +++ b/pkg/document/plugin/templater/templater.go @@ -75,7 +75,7 @@ func (t *plugin) Filter(items []*yaml.RNode) ([]*yaml.RNode, error) { res, ok := p.Outputs[0].(*kio.PackageBuffer) if !ok { - return nil, fmt.Errorf("Output conversion error") + return nil, fmt.Errorf("output conversion error") } return append(items, res.Nodes...), nil } diff --git a/pkg/events/printers_test.go b/pkg/events/printers_test.go index 7db213d9b..5eeb18bf8 100644 --- a/pkg/events/printers_test.go +++ b/pkg/events/printers_test.go @@ -43,9 +43,9 @@ func TestPrintEvent(t *testing.T) { { name: "Fail on formatter type", formatterType: events.YAMLPrinter, - errString: "Error on write", + errString: "error on write", writer: fakeWriter{ - writeErr: fmt.Errorf("Error on write"), + writeErr: fmt.Errorf("error on write"), }, }, } diff --git a/pkg/k8s/kubeconfig/kubeconfig_test.go b/pkg/k8s/kubeconfig/kubeconfig_test.go index 089066ae7..97f41dba9 100644 --- a/pkg/k8s/kubeconfig/kubeconfig_test.go +++ b/pkg/k8s/kubeconfig/kubeconfig_test.go @@ -83,9 +83,9 @@ users: ) var ( - errTempFile = fmt.Errorf("TempFile Error") - errSourceFunc = fmt.Errorf("Source func error") - errWriter = fmt.Errorf("Writer error") + errTempFile = fmt.Errorf("tempFile Error") + errSourceFunc = fmt.Errorf("source func error") + errWriter = fmt.Errorf("writer error") testValidKubeconfigAPI = &v1alpha1.KubeConfig{ Config: v1.Config{ CurrentContext: "test",