Improve help message when using "plonecli -l"
Open
Nobody has claimed this yet.
04 type: enhancement
31 needs: help
41 lvl: easy
- Dominant language
- Python
- Stars
- 20
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
- Plone CLI version:
0.2.0
- Python version:
2.7.9
- Operating System:
Description
Improve help.
What I Did
plonecli -l [17:21:31]
Available mr.bob templates:
- buildout
- addon
- vocabulary
- theme
- behavior
- content_type
- theme_package
And then:
plonecli create addon [17:21:55]
Usage: plonecli create [OPTIONS] TEMPLATE NAME
Try "plonecli create -h" for help.
Error: Missing argument "name".
I suggest adding the last message plonecli create addon src/collective.todo available at the official docs https://github.com/plone/plonecli#creating-a-plone-add-on. It would be nice to solve https://github.com/plone/plonecli/issues/28 before this issue.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the CLI entry points for plonecli -l and plonecli create, and inspect how their help and missing-argument messages are assembled. Compare the behavior with the official creating-a-Plone-add-on documentation and check issue #28 first; done means the suggested command appears in the relevant help output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100