From 39a65528086d78806d7a395b2fc241c139e63a65 Mon Sep 17 00:00:00 2001 From: JAYATI SHRIVASTAVA Date: Sun, 16 Aug 2020 17:49:40 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20docs=20with=20the=20new?= =?UTF-8?q?=20--help=20argument=20(#135)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sebastián Ramírez --- docs/tutorial/commands/callback.md | 2 +- .../multiple-values/arguments-with-multiple-values.md | 2 +- docs/tutorial/parameter-types/bool.md | 6 +++--- docs/tutorial/parameter-types/datetime.md | 5 ++++- docs/tutorial/parameter-types/enum.md | 2 +- docs/tutorial/parameter-types/index.md | 9 ++++++--- docs/tutorial/parameter-types/number.md | 7 +++++-- 7 files changed, 21 insertions(+), 12 deletions(-) diff --git a/docs/tutorial/commands/callback.md b/docs/tutorial/commands/callback.md index fb4ca03..6235ade 100644 --- a/docs/tutorial/commands/callback.md +++ b/docs/tutorial/commands/callback.md @@ -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. diff --git a/docs/tutorial/multiple-values/arguments-with-multiple-values.md b/docs/tutorial/multiple-values/arguments-with-multiple-values.md index d009ee7..5783c8e 100644 --- a/docs/tutorial/multiple-values/arguments-with-multiple-values.md +++ b/docs/tutorial/multiple-values/arguments-with-multiple-values.md @@ -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. diff --git a/docs/tutorial/parameter-types/bool.md b/docs/tutorial/parameter-types/bool.md index 26629ac..1d69f47 100644 --- a/docs/tutorial/parameter-types/bool.md +++ b/docs/tutorial/parameter-types/bool.md @@ -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. diff --git a/docs/tutorial/parameter-types/datetime.md b/docs/tutorial/parameter-types/datetime.md index 4a8e6b7..afc4155 100644 --- a/docs/tutorial/parameter-types/datetime.md +++ b/docs/tutorial/parameter-types/datetime.md @@ -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. diff --git a/docs/tutorial/parameter-types/enum.md b/docs/tutorial/parameter-types/enum.md index 1db01cf..6af834b 100644 --- a/docs/tutorial/parameter-types/enum.md +++ b/docs/tutorial/parameter-types/enum.md @@ -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. diff --git a/docs/tutorial/parameter-types/index.md b/docs/tutorial/parameter-types/index.md index b257aca..db78037 100644 --- a/docs/tutorial/parameter-types/index.md +++ b/docs/tutorial/parameter-types/index.md @@ -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. diff --git a/docs/tutorial/parameter-types/number.md b/docs/tutorial/parameter-types/number.md index 29e28ee..4d29ea3 100644 --- a/docs/tutorial/parameter-types/number.md +++ b/docs/tutorial/parameter-types/number.md @@ -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.