Skip to content

Commit

Permalink
docs: add LongHelp to gno bug, remove \n from gnodev LongHelp (gn…
Browse files Browse the repository at this point in the history
…olang#2180)

Added a LongDesc to `gno bug help`.

For gnodev -h think the help body should be on one long line to let it
flow naturally depending on the terminal's width.

Co-authored-by: grepsuzette <[email protected]>
  • Loading branch information
grepsuzette and grepsuzette authored May 24, 2024
1 parent f24690e commit 8a728ff
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
4 changes: 1 addition & 3 deletions contribs/gnodev/cmd/gnodev/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,7 @@ func main() {
Name: "gnodev",
ShortUsage: "gnodev [flags] [path ...]",
ShortHelp: "runs an in-memory node and gno.land web server for development purposes.",
LongHelp: `The gnodev command starts an in-memory node and a gno.land web interface
primarily for realm package development. It automatically loads the 'examples' directory and any
additional specified paths.`,
LongHelp: `The gnodev command starts an in-memory node and a gno.land web interface primarily for realm package development. It automatically loads the 'examples' directory and any additional specified paths.`,
},
cfg,
func(_ context.Context, args []string) error {
Expand Down
13 changes: 12 additions & 1 deletion gnovm/cmd/gno/bug.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ func newBugCmd(io commands.IO) *commands.Command {
Name: "bug",
ShortUsage: "bug",
ShortHelp: "Start a bug report",
LongHelp: `opens https://github.com/gnolang/gno/issues in a browser.
The new issue body is prefilled for you with the following information:
- Go version (example: go1.22.2)
- OS and CPU architecture (example: linux/amd64)
- Gno commit hash causing the issue (example: f24690e7ebf325bffcfaf9e328c3df8e6b21e50c)
The rest of the report consists of markdown sections such as ### Steps to reproduce
that you can edit.
`,
},
cfg,
func(_ context.Context, args []string) error {
Expand All @@ -74,7 +85,7 @@ func (c *bugCfg) RegisterFlags(fs *flag.FlagSet) {
&c.skipBrowser,
"skip-browser",
false,
"do not open the browser",
"output a prefilled issue template on the cli instead",
)
}

Expand Down

0 comments on commit 8a728ff

Please sign in to comment.