topics with no same-name command give odd help info

[rossiam]

topics with no same-name command give odd help info

[mdonnalley]

@rossiam

The usage section in this case indicates that you can use the topic by specifying a sub command,

USAGE
  $ topic-test topic-only COMMAND

I believe this is a valid usage string so I'm not convinced that we should get rid of it but I'm open to hearing arguments about why it should.

Also, the description for the topic can be configured by adding it to the oclif section of your package.json. For instance,

"oclif": {
"topics": {
      "topic-only": {
        "description": "This topic has no top-level command"
      }
    }
}

[rossiam]

Thanks for the help. I wasn't aware of the configuration in package.json. I'm closing this although I still think there is room for improvement. A couple of errors I made in the original description of this:

1. I shouldn't have said there "there should be no USAGE stanza" stanza under expected behavior. The default USAGE stanza is describing the sub-commands perfectly. It's only the description that is off.
2. I should have defined "same-name command". What I mean by this is a topic with no index.ts and no <topic-name>.ts like topic-only in the example.
3. I could have been more clear that I think the current behavior is correct when there is a same-name command. For example, the topic topic-and-command produces a good description. I just think the default description for a topic with no same-name command should be different or even left out entirely.