Improve help message when using "plonecli create"

Open
#28 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Start by reproducing the missing-argument case with plonecli create and compare it with plonecli create -h and plonecli -l. Trace the CLI's error and help handling; done means the missing-template message points users to the more useful top-level help without breaking the existing command help.

Written by the indexing model from the issue text.

Description

04 type: enhancement 31 needs: help 41 lvl: easy
  • Plone CLI version:

0.2.0

  • Python version:

2.7.9

  • Operating System:
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.

Dominant language
Python
Stars
20
Forks
12
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from plone/plonecli

All issues in plone/plonecli

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.