plone / plonecli

Plone Command Line Client - for creating and working with custom add-ons and themes
https://pypi.org/project/plonecli/
Other
19 stars 10 forks source link

Improve help message when using "plonecli create" #28

Open idgserpro opened 6 years ago

idgserpro commented 6 years ago

0.2.0

2.7.9

Description

Improve help.

What I Did

plonecli create                                                                                                                                                                 [17:14:23]
Usage: plonecli create [OPTIONS] TEMPLATE NAME
Try "plonecli create -h" for help.

Error: Missing argument "template".

And then:

plonecli create -h                                                                                                                                                              [17:14:27]
Usage: plonecli create [OPTIONS] TEMPLATE NAME

  Create a new Plone package

Options:
  -h, --help  Show this message and exit.

The first message Try "plonecli create -h" for help. is useless in this context. plonecli -l is much more useful in this case.

kakshay21 commented 6 years ago

@idgserpro Are you suggesting something like this?

plonecli create -h
Usage: plonecli create [OPTIONS] TEMPLATE_NAME PACKAGE_NAME

    Create a new Plone package

TEMPLATE_NAME -
   - addon
   - theme_package
   - buildout

Options:
  -h, --help  Show this message and exit.
idgserpro commented 6 years ago

Or something in the lines of:

plonecli create -h
Usage: plonecli create [OPTIONS] TEMPLATE_NAME PACKAGE_NAME

    Create a new Plone package. Run "plonecli -l" to see available template names.

So your TEMPLATE_NAME would always be up to date.

idgserpro commented 6 years ago

I think plonecli add could have the same treatment.

mzfr commented 5 years ago

Hi @idgserpro I would like to work on this issue.

idgserpro commented 5 years ago

Hi @mzfr. We're not maintainers of this project, I think you can keep asking for advice on the PR you made like https://github.com/plone/plonecli/pull/41#issuecomment-453918269.