Skip to content

Commit

Permalink
help text not formatted well (#316)
Browse files Browse the repository at this point in the history
  • Loading branch information
janelletavares authored Apr 15, 2022
1 parent c7c2b0e commit ac91128
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 15 deletions.
12 changes: 7 additions & 5 deletions cmd/meroxa/root/apps/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,13 @@ func (*Deploy) Usage() string {
func (*Deploy) Docs() builder.Docs {
return builder.Docs{
Short: "Deploy a Meroxa Data Application",
Long: "This command will deploy the application specified in `--path`" +
"(or current working directory if not specified) to our Meroxa Platform." +
"If deployment was successful, you should expect an application you'll be able to fully manage",
Example: "meroxa apps deploy # assumes you run it from the app directory\n" +
"meroxa apps deploy --path ./my-app",
Long: `This command will deploy the application specified in '--path'
(or current working directory if not specified) to our Meroxa Platform.
If deployment was successful, you should expect an application you'll be able to fully manage
`,
Example: `meroxa apps deploy # assumes you run it from the app directory
meroxa apps deploy --path ./my-app
`,
}
}

Expand Down
11 changes: 6 additions & 5 deletions cmd/meroxa/root/apps/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,12 @@ func (*Init) Usage() string {
func (*Init) Docs() builder.Docs {
return builder.Docs{
Short: "Initialize a Meroxa Data Application",
Example: "meroxa apps init my-app --path ~/code --lang js" +
"meroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directory" +
"meroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.org" +
"meroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go module" +
"meroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory",
Example: `meroxa apps init my-app --path ~/code --lang js
meroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directory
meroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go module
meroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory
meroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.org
`,
}
}

Expand Down
9 changes: 4 additions & 5 deletions cmd/meroxa/root/apps/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,10 @@ func (*Run) Usage() string {
func (*Run) Docs() builder.Docs {
return builder.Docs{
Short: "Execute a Meroxa Data Application locally",
Long: "meroxa apps run will build your app locally to then run it\n" +
"locally on --path.",
Example: "meroxa apps run # assumes you run it from the app directory\n" +
"meroxa apps run --path ../js-demo --lang js # in case you didn't specify lang on your app.json" +
"meroxa apps run --path ../go-demo # it'll use lang defined in your app.json",
Long: "meroxa apps run will build your app locally to then run it locally in --path.",
Example: `meroxa apps run # assumes you run it from the app directory
meroxa apps run --path ../go-demo # it'll use lang defined in your app.json
`,
}
}

Expand Down

0 comments on commit ac91128

Please sign in to comment.