typings command --help should include description of command

[mcclure]

Say I type typings list --help. I get:

typings list

Options:
  [--production] List only production dependencies (omit dev dependencies)

Aliases: la, ll, ls

After reading this, I still don't know what typings list does. My expected behavior is that the --help for a command will explain the command, not just its options.

To address this, the attached patch copies the one-line description from commands.md into the individual command help() functions. I have also addressed minor style inconsistencies in the descriptions themselves (periods, backticks, inconsistent way the project in the current directory is referred to).

I have built this PR as described in the README but have not tested it. I can not figure out how to invoke the locally built typings after building. (Perhaps this information should be in the README).

[blakeembrey]

Sounds good, but the documentation exists in https://github.com/typings/typings/blob/master/scripts/docs-commands.js - it's generated via a script. The script will need to be patched for this to work.

If you want to invoke it as a command, you can link it using npm link.

[mcclure]

Okay. So i think the thing to do is to move the descriptions into the help() functions, then excise that field from docs-commands.js, and then running docs-commands.js will import the descriptions properly into the commands.md?

[blakeembrey]

Sounds perfect 👍