Skip to content

Commit

Permalink
changed docs to use parenthesis around args for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
xadhatter committed Oct 23, 2023
1 parent 29e2224 commit df6d986
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion cmd/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
)

var buildCmd = &cobra.Command{
Use: "build [component name]",
Use: "build (component name)",
Args: cobra.ExactArgs(1),
PreRun: setup,
Run: build,
Expand Down
2 changes: 1 addition & 1 deletion cmd/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
)

var deployCmd = &cobra.Command{
Use: "deploy [deployment name]",
Use: "deploy (deployment name)",
Args: cobra.ExactArgs(1),
PreRun: setup,
Run: runDeploy,
Expand Down
2 changes: 1 addition & 1 deletion cmd/proxy.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
)

var proxyCmd = &cobra.Command{
Use: "proxy [local port]",
Use: "proxy (local port)",
Args: cobra.ExactArgs(1),
PreRun: setup,
Run: runProxy,
Expand Down
2 changes: 1 addition & 1 deletion cmd/publish.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
)

var publishCmd = &cobra.Command{
Use: "publish [deploy-name]",
Use: "publish (deploy-name)",
Args: cobra.MaximumNArgs(1),
PreRun: setup,
RunE: runPublish,
Expand Down
2 changes: 1 addition & 1 deletion cmd/release.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
)

var releaseCmd = &cobra.Command{
Use: "release [release name]",
Use: "release (release name)",
Args: cobra.ExactArgs(1),
PreRun: setup,
Run: release,
Expand Down
2 changes: 1 addition & 1 deletion docs/fox_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Examples:


```
fox build [component name] [flags]
fox build (component name) [flags]
```

### Options
Expand Down
2 changes: 1 addition & 1 deletion docs/fox_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Deploy KubeFox app using the version from the currently checked out Git commit

```
fox deploy [deployment name] [flags]
fox deploy (deployment name) [flags]
```

### Options
Expand Down
2 changes: 1 addition & 1 deletion docs/fox_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Examples:


```
fox proxy [local port] [flags]
fox proxy (local port) [flags]
```

### Options
Expand Down
2 changes: 1 addition & 1 deletion docs/fox_publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Builds, pushes, and deploys KubeFox apps using the version of the currently checked out Git commit

```
fox publish [deploy-name] [flags]
fox publish (deploy-name) [flags]
```

### Options
Expand Down
2 changes: 1 addition & 1 deletion docs/fox_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Examples:


```
fox release [release name] [flags]
fox release (release name) [flags]
```

### Options
Expand Down

0 comments on commit df6d986

Please sign in to comment.