📝 Update docs with the new --help argument (#135)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
JAYATI SHRIVASTAVA 2020-08-16 17:49:40 +05:30 committed by GitHub
parent ab5da80365
commit 39a6552808
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 21 additions and 12 deletions

View file

@ -37,7 +37,7 @@ Usage: main.py [OPTIONS] COMMAND [ARGS]...
Manage users in the awesome CLI app.
Options:
--verbose / --no-verbose
--verbose / --no-verbose [default: False]
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.

View file

@ -46,7 +46,7 @@ $ python main.py --help
Usage: main.py [OPTIONS] [NAMES]...
Arguments:
[NAMES]... [default: Harry, Hermione, Ron]
[NAMES]... Select 3 characters to play with [default: Harry, Hermione, Ron]
Options:
--install-completion Install completion for the current shell.

View file

@ -24,7 +24,7 @@ $ python main.py --help
Usage: main.py [OPTIONS]
Options:
--force
--force [default: False]
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.
@ -121,7 +121,7 @@ $ python main.py --help
Usage: main.py [OPTIONS]
Options:
-f, --force / -F, --no-force
-f, --force / -F, --no-force [default: False]
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.
@ -166,7 +166,7 @@ $ python main.py --help
Usage: main.py [OPTIONS]
Options:
/ -d, --demo
/ -d, --demo [default: True]
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.

View file

@ -18,7 +18,10 @@ Check it:
```console
$ python main.py --help
Usage: main.py [OPTIONS] [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
Usage: main.py [OPTIONS] BIRTH:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
Arguments:
BIRTH:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S][required]
Options:
--install-completion Install completion for the current shell.

View file

@ -20,7 +20,7 @@ $ python main.py --help
Usage: main.py [OPTIONS]
Options:
--network [simple|conv|lstm]
--network [simple|conv|lstm] [default: simple]
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.

View file

@ -26,10 +26,13 @@ $ python main.py --help
// Notice how --age is an INTEGER and --height-meters is a FLOAT
Usage: main.py [OPTIONS] NAME
Arguments:
NAME [required]
Options:
--age INTEGER
--height-meters FLOAT
--female / --no-female
--age INTEGER [default: 20]
--height-meters FLOAT [default: 1.89]
--female / --no-female [default: True]
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.

View file

@ -18,9 +18,12 @@ $ python main.py --help
// Notice the extra RANGE in the help text for --age and --score
Usage: main.py [OPTIONS] ID
Arguments:
ID [required]
Options:
--age INTEGER RANGE
--score FLOAT RANGE
--age INTEGER RANGE [default: 20]
--score FLOAT RANGE [default: 0]
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.