diff --git a/docs/tutorial/arguments/default.md b/docs/tutorial/arguments/default.md index 3d5de98dfa..c85bac0c56 100644 --- a/docs/tutorial/arguments/default.md +++ b/docs/tutorial/arguments/default.md @@ -41,8 +41,6 @@ Arguments: [NAME] [default: Wade Wilson] Options: - --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. // With no optional CLI argument @@ -98,8 +96,6 @@ Arguments: [NAME] [default: (dynamic)] Options: - --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. // Try it several times, it will use a random default each time diff --git a/docs/tutorial/arguments/envvar.md b/docs/tutorial/arguments/envvar.md index 79637e551b..18e8f08124 100644 --- a/docs/tutorial/arguments/envvar.md +++ b/docs/tutorial/arguments/envvar.md @@ -31,8 +31,6 @@ Arguments: [NAME] [env var: AWESOME_NAME;default: World] Options: - --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. // Call it without a CLI argument @@ -91,8 +89,6 @@ Arguments: [NAME] [env var: AWESOME_NAME, GOD_NAME;default: World] Options: - --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. // Try the first env var @@ -142,8 +138,6 @@ Arguments: [NAME] [default: World] Options: - --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. // But it will still be able to use it diff --git a/docs/tutorial/arguments/help.md b/docs/tutorial/arguments/help.md index 8477823063..34ec101100 100644 --- a/docs/tutorial/arguments/help.md +++ b/docs/tutorial/arguments/help.md @@ -41,8 +41,6 @@ Arguments: NAME The name of the user to greet [required] Options: - --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. ``` @@ -83,8 +81,6 @@ Arguments: NAME The name of the user to greet [required] Options: - --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. ``` @@ -125,8 +121,6 @@ Arguments: [NAME] Who to greet [default: World] Options: - --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. ``` @@ -165,9 +159,6 @@ Arguments: [NAME] Who to greet Options: - --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. ``` @@ -211,8 +202,6 @@ Arguments: Options: - --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. // See it shows "(Deadpoolio the amazing's name)" instead of the actual default of "Wade Wilson" @@ -270,8 +259,6 @@ Arguments: ✨username✨ [default: World] Options: - --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. ``` @@ -319,11 +306,6 @@ $ python main.py --help │ age [AGE] The user's age │ ╰───────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────╮ -│ --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. │ ╰───────────────────────────────────────────────────────────────────╯ ``` @@ -372,8 +354,6 @@ Usage: main.py [OPTIONS] [NAME] Say hi to NAME very gently, like Dirk. Options: - --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/arguments/optional.md b/docs/tutorial/arguments/optional.md index 6b21cdc3fa..60f1dbac33 100644 --- a/docs/tutorial/arguments/optional.md +++ b/docs/tutorial/arguments/optional.md @@ -139,8 +139,6 @@ Arguments: [NAME] Options: - --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/commands/index.md b/docs/tutorial/commands/index.md index 373f1187d3..1f7fcd9b0b 100644 --- a/docs/tutorial/commands/index.md +++ b/docs/tutorial/commands/index.md @@ -118,6 +118,11 @@ Options: There's a little detail that is worth noting here. +Now the help shows two new *CLI options*: + +* `--install-completion` +* `--show-completion` + To get shell/tab completion, it's necessary to build a package that you and your users can install and **call directly**. So instead of running a Python script like: diff --git a/docs/tutorial/first-steps.md b/docs/tutorial/first-steps.md index 9ccccaabc7..1f2371f0ab 100644 --- a/docs/tutorial/first-steps.md +++ b/docs/tutorial/first-steps.md @@ -25,14 +25,6 @@ $ python main.py --help Usage: main.py [OPTIONS] ╭─ Options ─────────────────────────────────────────╮ -│ --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. │ ╰───────────────────────────────────────────────────╯ @@ -251,12 +243,6 @@ $ python main.py --help ╰─────────────────────────────────────────────────────────────────╯ ╭─ Options ───────────────────────────────────────────────────────╮ │ --formal --no-formal [default: no-formal] │ -│ --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. │ ╰─────────────────────────────────────────────────────────────────╯ @@ -316,14 +302,6 @@ $ python main.py --help ╭─ Options ─────────────────────────────────────────────────────────╮ │ --lastname TEXT │ │ --formal --no-formal [default: no-formal] │ -│ --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. │ ╰───────────────────────────────────────────────────────────────────╯ @@ -394,14 +372,6 @@ $ python main.py --help ╭─ Options ─────────────────────────────────────────────────────────╮ │ --lastname TEXT │ │ --formal --no-formal [default: no-formal] │ -│ --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 36287a401b..d55abfde52 100644 --- a/docs/tutorial/multiple-values/arguments-with-multiple-values.md +++ b/docs/tutorial/multiple-values/arguments-with-multiple-values.md @@ -60,8 +60,6 @@ Arguments: [NAMES]... Select 3 characters to play with [default: Harry, Hermione, Ron] Options: - --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. // Use it with its defaults diff --git a/docs/tutorial/multiple-values/options-with-multiple-values.md b/docs/tutorial/multiple-values/options-with-multiple-values.md index 52154a7bd4..d710966a99 100644 --- a/docs/tutorial/multiple-values/options-with-multiple-values.md +++ b/docs/tutorial/multiple-values/options-with-multiple-values.md @@ -79,8 +79,6 @@ Usage: main.py [OPTIONS] Options: --user <TEXT INTEGER BOOLEAN>... - --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. // Now try it diff --git a/docs/tutorial/options/help.md b/docs/tutorial/options/help.md index b1ba0e1377..13df644a51 100644 --- a/docs/tutorial/options/help.md +++ b/docs/tutorial/options/help.md @@ -54,8 +54,6 @@ Arguments: Options: --lastname TEXT Last name of person to greet. [default: ] --formal / --no-formal Say hi formally. [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. // Now you have a help text for the --lastname and --formal CLI options 🎉 @@ -103,11 +101,6 @@ $ python main.py --help ╰───────────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────────╮ │ --lastname TEXT Last name of person to greet. │ -│ --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. │ ╰───────────────────────────────────────────────────────────────────╯ ╭─ Customization and Utils ─────────────────────────────────────────╮ @@ -164,8 +157,6 @@ Usage: main.py [OPTIONS] Options: --fullname TEXT - --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. // Notice there's no [default: Wade Wilson] 🔥 diff --git a/docs/tutorial/options/name.md b/docs/tutorial/options/name.md index 1a05fd50ba..e44e2f702a 100644 --- a/docs/tutorial/options/name.md +++ b/docs/tutorial/options/name.md @@ -66,8 +66,6 @@ Usage: main.py [OPTIONS] Options: --name TEXT [required] - --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. // Try it @@ -226,8 +224,6 @@ Usage: main.py [OPTIONS] Options: -n, --name TEXT [required] - --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. // Try the short version @@ -269,8 +265,6 @@ Usage: main.py [OPTIONS] Options: -n TEXT [required] - --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. // Try it @@ -313,8 +307,6 @@ Usage: main.py [OPTIONS] Options: -n, --user-name TEXT [required] - --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. // Try it @@ -366,8 +358,6 @@ Usage: main.py [OPTIONS] Options: -n, --name TEXT [required] -f, --formal - --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. // Try the short versions diff --git a/docs/tutorial/options/required.md b/docs/tutorial/options/required.md index ff37da10ea..489bf3b9cd 100644 --- a/docs/tutorial/options/required.md +++ b/docs/tutorial/options/required.md @@ -67,8 +67,6 @@ Usage: main.py [OPTIONS] NAME Options: --lastname TEXT [required] - --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. // It now tells you that --lastname is required 🎉 diff --git a/docs/tutorial/options/version.md b/docs/tutorial/options/version.md index 51a3415d3a..0e5ff716c7 100644 --- a/docs/tutorial/options/version.md +++ b/docs/tutorial/options/version.md @@ -43,9 +43,6 @@ Usage: main.py [OPTIONS] Options: --version --name TEXT - --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/bool.md b/docs/tutorial/parameter-types/bool.md index 0aca205e7a..f89772db4b 100644 --- a/docs/tutorial/parameter-types/bool.md +++ b/docs/tutorial/parameter-types/bool.md @@ -36,8 +36,6 @@ Usage: main.py [OPTIONS] Options: --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. // Try it: @@ -99,8 +97,6 @@ Usage: main.py [OPTIONS] Options: --accept / --reject - --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. // Try it @@ -155,8 +151,6 @@ Usage: main.py [OPTIONS] Options: -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. // Try with the short name -f @@ -211,8 +205,6 @@ Usage: main.py [OPTIONS] Options: / -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. // Try it diff --git a/docs/tutorial/parameter-types/datetime.md b/docs/tutorial/parameter-types/datetime.md index ddc80b656a..fe1f18dbf5 100644 --- a/docs/tutorial/parameter-types/datetime.md +++ b/docs/tutorial/parameter-types/datetime.md @@ -25,8 +25,6 @@ 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. - --show-completion Show completion for the current shell, to copy it or customize the installation. --help Show this message and exit. // Pass a datetime diff --git a/docs/tutorial/parameter-types/enum.md b/docs/tutorial/parameter-types/enum.md index b6ba27873a..767c329b27 100644 --- a/docs/tutorial/parameter-types/enum.md +++ b/docs/tutorial/parameter-types/enum.md @@ -21,8 +21,6 @@ Usage: main.py [OPTIONS] Options: --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. // Try it diff --git a/docs/tutorial/parameter-types/index.md b/docs/tutorial/parameter-types/index.md index db78037bf9..8a0e5dfbfa 100644 --- a/docs/tutorial/parameter-types/index.md +++ b/docs/tutorial/parameter-types/index.md @@ -33,8 +33,6 @@ Options: --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. // Call it with CLI parameters diff --git a/docs/tutorial/parameter-types/number.md b/docs/tutorial/parameter-types/number.md index d22ac3f45a..2bf6b423ca 100644 --- a/docs/tutorial/parameter-types/number.md +++ b/docs/tutorial/parameter-types/number.md @@ -35,8 +35,6 @@ Arguments: Options: --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. // Pass all the CLI parameters