Inconsistent help message formatting

[fmoor]

The help for edgedb instance is formatted strangely when --help is passed but not for -h or help . I haven't found another command that has this format or difference between help commands.

• EdgeDB CLI Version: EdgeDB CLI 1.0.0-rc.2+d20211123.g786c626b8
• OS Version: ubuntu 21.04

Steps to Reproduce:

$ edgedb instance -h
edgedb-instance

Manage local EdgeDB instances

USAGE:
    edgedb instance <SUBCOMMAND>

FLAGS:
    -h, --help    Prints help information

SUBCOMMANDS:
    create            Initialize a new EdgeDB instance
    destroy           Destroy an instance and remove the data
    help              Prints this message or the help of the given subcommand(s)
    link              Link a remote instance
    list              Show all instances
    logs              Show logs of an instance
    reset-password    Reset password for a user in the instance
    restart           Restart an instance
    revert            Revert a major instance upgrade
    start             Start an instance
    status            Show status of a matching instance
    stop              Stop an instance
    unlink            Unlink a remote instance
    upgrade           Upgrade installations and instances
$ edgedb instance --help
edgedb-instance

Manage local EdgeDB instances

USAGE:
    edgedb instance <SUBCOMMAND>

FLAGS:
    -h, --help
            Prints help information

SUBCOMMANDS:
    create
            Initialize a new EdgeDB instance
    destroy
            Destroy an instance and remove the data
    help
            Prints this message or the help of the given subcommand(s)
    link
            Link a remote instance
    list
            Show all instances
    logs
            Show logs of an instance
    reset-password
            Reset password for a user in the instance
    restart
            Restart an instance
    revert
            Revert a major instance upgrade
    start
            Start an instance
    status
            Show status of a matching instance
    stop
            Stop an instance
    unlink
            Unlink a remote instance
    upgrade
            Upgrade installations and instances
$ edgedb instance help
edgedb-instance

Manage local EdgeDB instances

USAGE:
    edgedb instance <SUBCOMMAND>

FLAGS:
    -h, --help    Prints help information

SUBCOMMANDS:
    create            Initialize a new EdgeDB instance
    destroy           Destroy an instance and remove the data
    help              Prints this message or the help of the given subcommand(s)
    link              Link a remote instance
    list              Show all instances
    logs              Show logs of an instance
    reset-password    Reset password for a user in the instance
    restart           Restart an instance
    revert            Revert a major instance upgrade
    start             Start an instance
    status            Show status of a matching instance
    stop              Stop an instance
    unlink            Unlink a remote instance
    upgrade           Upgrade installations and instances

[fmoor]

Also, edgedb instance unlink --help has the same staggered formatting.

[tailhook]

I'm not sure what you mean. instance -h and instance --help output is currently the same (probably it was changed since issue was created). Although, in clap those are a little bit different things, as --help is supposed to show long help, which probably means there might be a paragraph or more about each command, this is why description is put on the separate line to the option/command name.

So I think it's good enough.