search

maxlath / wikibase-cli

read and edit a Wikibase instance from the command line
MIT License
223 stars 24 forks source link

wd --help should show main command description #87

Closed waldyrious closed 4 years ago

waldyrious commented 4 years ago

I expected to see a description of the main wd command when calling it with the --help option:

❯ wd --help

  Usage: wd [options] [command]

  Options:

    -V, --version                   output the version number
    -h, --help                      output usage information

  Commands:

    ...

IMO there should be a Description field alongside Usage, Options and Commands (or simply the string above the Usage line), but there was none.

I tried to figure out how to do this myself; the commander documentation suggests using .description(), but bin/wd seems too smart now; apparently the description is extracted from the metadata which should be here somewhere, but there's no entry for the main commands there; and to add on top of my confusion, lib/program.js seems to suggest that the help flag only shows command examples? I'm confused! 😅

waldyrious commented 4 years ago

Maybe there needs to be some Implementation notes / Contributing documentation explaining the overall architecture of the project, to allow other people to contribute more easily :)

maxlath commented 4 years ago

A description was added in de17e57, so I close this issue, but you're welcome to suggest a better description