git-repo icon indicating copy to clipboard operation
git-repo copied to clipboard

Make help documentation more concise

Open guyzmo opened this issue 9 years ago • 0 comments

Current documentation is way too verbose (29 lines, cf __doc__), and it could be written as follows (16 lines!):

Usage:
    {self} [--path=<path>] [-v...] <target> fork [<user>/<repo>] [<branch>] [--clone]
    {self} [--path=<path>] [-v...] <target> create [<user>/<repo>] [--add]
    {self} [--path=<path>] [-v...] <target> delete [<user>/<repo>] [-f]
    {self} [--path=<path>] [-v...] <target> open [<user>/<repo>]
    {self} [--path=<path>] [-v...] <target> clone <user>/<repo> [<branch>]
    {self} [--path=<path>] [-v...] <target> add <user>/<repo> [<name>] [--tracking=<branch>] [-a]
    {self} [--path=<path>] [-v...] <target> request [<user>/<repo>] (list|ls)
    {self} [--path=<path>] [-v...] <target> request [<user>/<repo>] fetch <request>
    {self} [--path=<path>] [-v...] <target> request [<user>/<repo>] create [<remote_branch> [<local_branch>]] <title> [--branch=<remote>] [--message=<message>]
    {self} [--path=<path>] [-v...] <target> gist (list|ls) [<gist>]
    {self} [--path=<path>] [-v...] <target> gist clone <gist>
    {self} [--path=<path>] [-v...] <target> gist fetch <gist> [<gist_file>]
    {self} [--path=<path>] [-v...] <target> gist create [--secret] <description> [<gist_path> <gist_path>...]
    {self} [--path=<path>] [-v...] <target> gist delete <gist> [-f]
    {self} [--path=<path>] [-v...] [<target>] config [--config=<gitconfig>]
    {self} --help

The issue lies within docopt and I've opened an issue about it. Let's hope we'll find a way.

Another approach would be to consider changing the approach of the help page, by going through a refactoring of the current CLI API design, which could be considered for v2.

guyzmo avatar Jun 07 '16 11:06 guyzmo