summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris Sullins <chris.sullins@oracle.com>2018-10-31 22:46:19 -0700
committerDavid Lord <davidism@gmail.com>2020-02-23 18:28:06 -0800
commit2efe22f6dc7b4068c5317eb00adea2de25970a5d (patch)
tree9b366e670a87f27ea6b340dcdd79415b8384555a /docs
parentf546f06a7baa846684cdf207df24b021441733a8 (diff)
downloadclick-2efe22f6dc7b4068c5317eb00adea2de25970a5d.tar.gz
clarify multiple options
Diffstat (limited to 'docs')
-rw-r--r--docs/bashcomplete.rst8
-rw-r--r--docs/options.rst2
-rw-r--r--docs/parameters.rst3
-rw-r--r--docs/utils.rst4
4 files changed, 10 insertions, 7 deletions
diff --git a/docs/bashcomplete.rst b/docs/bashcomplete.rst
index bff38fa..64eede8 100644
--- a/docs/bashcomplete.rst
+++ b/docs/bashcomplete.rst
@@ -18,10 +18,10 @@ only supports completion for Bash and Zsh.
What it Completes
-----------------
-Generally, the Bash completion support will complete subcommands, options
-and any option or argument values where the type is click.Choice.
-Subcommands and choices are always listed whereas options only if at
-least a dash has been provided. Example::
+Generally, the Bash completion support will complete subcommands,
+options, and any option or argument values where the type is
+:class:`click.Choice`. Subcommands and choices are always listed whereas
+options are only listed if at least a dash has been provided. ::
$ repo <TAB><TAB>
clone commit copy delete setuser
diff --git a/docs/options.rst b/docs/options.rst
index 29000a1..c60b45f 100644
--- a/docs/options.rst
+++ b/docs/options.rst
@@ -145,6 +145,8 @@ used. The above example is thus equivalent to this:
def putitem(item):
click.echo('name=%s id=%d' % item)
+.. _multiple-options:
+
Multiple Options
----------------
diff --git a/docs/parameters.rst b/docs/parameters.rst
index 856e277..7ee145c 100644
--- a/docs/parameters.rst
+++ b/docs/parameters.rst
@@ -28,7 +28,8 @@ available for options:
On the other hand arguments, unlike options, can accept an arbitrary number
of arguments. Options can strictly ever only accept a fixed number of
-arguments (defaults to 1).
+arguments (defaults to 1), or they may be specified multiple times using
+:ref:`multiple-options`.
Parameter Types
---------------
diff --git a/docs/utils.rst b/docs/utils.rst
index 4ac3374..902e5fd 100644
--- a/docs/utils.rst
+++ b/docs/utils.rst
@@ -33,7 +33,7 @@ suppressed by passing ``nl=False``::
Last but not least :func:`echo` uses click's intelligent internal output
streams to stdout and stderr which support unicode output on the Windows
console. This means for as long as you are using `click.echo` you can
-output unicode character (there are some limitations on the default font
+output unicode characters (there are some limitations on the default font
with regards to which characters can be displayed). This functionality is
new in Click 6.0.
@@ -211,7 +211,7 @@ Click supports launching editors automatically through :func:`edit`. This
is very useful for asking users for multi-line input. It will
automatically open the user's defined editor or fall back to a sensible
default. If the user closes the editor without saving, the return value
-will be `None` otherwise the entered text.
+will be ``None``, otherwise the entered text.
Example usage::