Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename NoRunCliktCommand #130

Closed
ajalt opened this issue Feb 15, 2020 · 3 comments · Fixed by #134
Closed

Rename NoRunCliktCommand #130

ajalt opened this issue Feb 15, 2020 · 3 comments · Fixed by #134
Labels
help wanted Extra attention is needed

Comments

@ajalt
Copy link
Owner

ajalt commented Feb 15, 2020

The name NoRunCliktCommand is not great.

If you can think of something better, please leave your suggestions in the comments of this issue.

@ajalt ajalt added the help wanted Extra attention is needed label Feb 15, 2020
@sebokopter
Copy link
Contributor

IMHO a typical usecase for NoRunCliktCommand is for having it as a skeleton for subcommands.

I'd suggest SkeletonCliktCommand therefore.
If you would like to explain what it is technically, than NoopCliktCommand would be my choice.

Other names which did come to my mind:

  • Root(Clikt)Command
  • Super(Clikt)Command
  • Parent(Clikt)Command
  • Plumbing(Clikt)Command
  • Scaffolding(Clikt)Command
  • Staging(Clikt)Command
  • Abstract(Clikt)Command
  • Empty(Clikt)Command
  • HelpOnly(Clikt)Command

@sschuberth
Copy link
Contributor

sschuberth commented Feb 21, 2020

I'd also vote for Empty(Clikt)Command or NoOp(Clikt)Command. Or to remove the class altogether, as its use seems to be limited.

@ajalt
Copy link
Owner Author

ajalt commented Feb 21, 2020

Thank you for the suggestions! I decided to go with NoOpCliktCommand.

I agree that it's not commonly used, but some people prefer treating their commands like data classes, and writing the business logic externally. That doesn't scale to subcommands, but it's easy enough to support that I don't mind leaving the class around.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants