Skip to content
This repository has been archived by the owner on Dec 18, 2017. It is now read-only.

Remove 'help' subcommand from command-line tool #1116

Closed
dougbu opened this issue Jan 21, 2015 · 4 comments
Closed

Remove 'help' subcommand from command-line tool #1116

dougbu opened this issue Jan 21, 2015 · 4 comments
Assignees
Milestone

Comments

@dougbu
Copy link
Member

dougbu commented Jan 21, 2015

  • kpm help packages add fails with a System.Exception: TODO: Error: unrecognized argument 'add'
    • this command is not an alias for the less-common kpm packages help add (that one works)
  • kpm packages add -? oddly describes the target packages directory as the "[source]"
  • other kpm packages subcommands have similar issues in their help
@davidfowl
Copy link
Member

This is the same bug as #547

@dougbu
Copy link
Member Author

dougbu commented Jan 21, 2015

@ChengTian
Copy link
Contributor

kpm help packages: shows help info of packages, which is a subcommand of kpm. In this case, help is a subcommand of kpm command.
kpm packages help add shows help info of add, which is a subcommand of kpm packages. In this case, help is a subcommand of kpm packages command.

kpm help packages add is invalid because the subcommand help of kpm only accepts one argument, which should be one of its peers (a subcommand of kpm).

The behavior is well-defined and consistent. But seems people don't like this consistency because it's not intuitive enough. @davidfowl , do we want to remove help subcommand and only use --help|-h option?

@davidfowl
Copy link
Member

Yes

@glennc glennc added the polish label Mar 13, 2015
@glennc glennc added this to the 1.0.0 milestone Mar 13, 2015
@muratg muratg modified the milestones: 1.0.0, 1.0.0-beta5 Mar 20, 2015
@muratg muratg modified the milestones: 1.0.0-beta6, 1.0.0-beta5 May 12, 2015
@ChengTian ChengTian changed the title Improve help for kpm packages Remove 'help' subcommand from command-line tool Jul 23, 2015
@ChengTian ChengTian added bug and removed polish labels Jul 23, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants