Skip to content

Commit

Permalink
change docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lindnerby committed Oct 15, 2024
1 parent a945f43 commit ec10a2f
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions cmd/modulectl/version/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import (

const (
use = "version"
short = "Print current modulectl version"
long = "Prints the current semantic version of the modulectl binary set at build time"
short = "Prints the current modulectl version."
long = "This command prints the current semantic version of the modulectl binary set at build time."
)

// Version will contain the binary version injected by make build target
Expand Down
4 changes: 2 additions & 2 deletions cmd/modulectl/version/cmd_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ func TestNewCmd_WhenCalled_CmdContainsUseDescription(t *testing.T) {
func TestNewCmd_WhenCalled_CmdContainsShortDescription(t *testing.T) {
cmd, _ := version.NewCmd()

assert.Equal(t, "Print current modulectl version", cmd.Short)
assert.Equal(t, "Prints the current modulectl version.", cmd.Short)
}

func TestNewCmd_WhenCalled_CmdContainsLongDescription(t *testing.T) {
cmd, _ := version.NewCmd()

assert.Equal(t, "Prints the current semantic version of the modulectl binary set at build time", cmd.Long)
assert.Equal(t, "This command prints the current semantic version of the modulectl binary set at build time.", cmd.Long)
}

func TestNewCmd_WhenCalled_CmdRunNotNil(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion docs/gen-docs/modulectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ A CLI from the Kyma Module Controller. Wonderful to use.
* [modulectl create](modulectl_create.md) - Creates a module bundled as an OCI artifact.
* [modulectl scaffold](modulectl_scaffold.md) - Generates necessary files required for module creation.

* [modulectl version](modulectl_version.md) - Print current modulectl version
* [modulectl version](modulectl_version.md) - Prints the current modulectl version.

4 changes: 2 additions & 2 deletions docs/gen-docs/modulectl_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: modulectl version
---

Print current modulectl version
Prints the current modulectl version.

## Synopsis

Prints the current semantic version of the modulectl binary set at build time
This command prints the current semantic version of the modulectl binary set at build time.

```bash
modulectl version [flags]
Expand Down

0 comments on commit ec10a2f

Please sign in to comment.