summaryrefslogtreecommitdiff
path: root/docs/features
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2020-02-13 13:39:53 -0500
committerKevin Van Brunt <kmvanbrunt@gmail.com>2020-02-13 13:39:53 -0500
commit41019de4b55f42d17149c29d380358dc38347948 (patch)
tree896f769ab1d919132b51ee0dbf7006cf07f87961 /docs/features
parentc3e3c1c595d65ec4c5fa2c9dac88ffa30cf4738e (diff)
downloadcmd2-git-41019de4b55f42d17149c29d380358dc38347948.tar.gz
Removed dash from 'tab complete' string
Diffstat (limited to 'docs/features')
-rw-r--r--docs/features/argument_processing.rst2
-rw-r--r--docs/features/completion.rst14
-rw-r--r--docs/features/embedded_python_shells.rst2
-rw-r--r--docs/features/initialization.rst2
-rw-r--r--docs/features/os.rst2
-rw-r--r--docs/features/scripting.rst4
-rw-r--r--docs/features/settings.rst4
7 files changed, 15 insertions, 15 deletions
diff --git a/docs/features/argument_processing.rst b/docs/features/argument_processing.rst
index 39a39804..82244d7e 100644
--- a/docs/features/argument_processing.rst
+++ b/docs/features/argument_processing.rst
@@ -325,7 +325,7 @@ Subcommands are supported for commands using either the ``@with_argparser`` or
is based on argparse sub-parsers.
You may add multiple layers of subcommands for your command. ``cmd2`` will
-automatically traverse and tab-complete subcommands for all commands using
+automatically traverse and tab complete subcommands for all commands using
argparse.
See the subcommands_ example to learn more about how to
diff --git a/docs/features/completion.rst b/docs/features/completion.rst
index 9103b543..a8c1cc85 100644
--- a/docs/features/completion.rst
+++ b/docs/features/completion.rst
@@ -1,7 +1,7 @@
Completion
==========
-``cmd2`` adds tab-completion of file system paths for all built-in commands
+``cmd2`` adds tab completion of file system paths for all built-in commands
where it makes sense, including:
- ``edit``
@@ -9,7 +9,7 @@ where it makes sense, including:
- ``run_script``
- ``shell``
-``cmd2`` also adds tab-completion of shell commands to the ``shell`` command.
+``cmd2`` also adds tab completion of shell commands to the ``shell`` command.
Additionally, it is trivial to add identical file system path completion to
your own custom commands. Suppose you have defined a custom command ``foo`` by
@@ -37,9 +37,9 @@ Tab Completion Using Argparse Decorators
----------------------------------------
When using one the Argparse-based :ref:`api/decorators:Decorators`, ``cmd2``
-provides automatic tab-completion of flag names.
+provides automatic tab completion of flag names.
-Tab-completion of argument values can be configured by using one of five
+Tab completion of argument values can be configured by using one of five
parameters to ``argparse.ArgumentParser.add_argument()``
- ``choices``
@@ -52,9 +52,9 @@ demonstration of how to use the ``choices_function`` and ``choices_method``
parameters. See the arg_decorators_ or argparse_completion_ example for a
demonstration of how to use the ``completer_method`` parameter.
-When tab-completing flags and/or argument values for a ``cmd2`` command using
+When tab completing flags and/or argument values for a ``cmd2`` command using
one of these decorators, ``cmd2`` keeps track of state so that once a flag has
-already previously been provided, it won't attempt to tab-complete it again.
+already previously been provided, it won't attempt to tab complete it again.
When no completion results exists, a hint for the current argument will be
displayed to help the user.
@@ -66,7 +66,7 @@ displayed to help the user.
CompletionItem For Providing Extra Context
------------------------------------------
-When tab-completing things like a unique ID from a database, it can often be
+When tab completing things like a unique ID from a database, it can often be
beneficial to provide the user with some extra context about the item being
completed, such as a description. To facilitate this, ``cmd2`` defines the
``CompletionItem`` class which can be returned from any of the 4 completion
diff --git a/docs/features/embedded_python_shells.rst b/docs/features/embedded_python_shells.rst
index 68377876..70765b21 100644
--- a/docs/features/embedded_python_shells.rst
+++ b/docs/features/embedded_python_shells.rst
@@ -67,7 +67,7 @@ code directory for an example of how to achieve this in your own applications.
Using ``py`` to run scripts directly is considered deprecated. The newer
``run_pyscript`` command is superior for doing this in two primary ways:
-- it supports tab-completion of file system paths
+- it supports tab completion of file system paths
- it has the ability to pass command-line arguments to the scripts invoked
There are no disadvantages to using ``run_pyscript`` as opposed to ``py
diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst
index 6824c7bf..b1ca4f05 100644
--- a/docs/features/initialization.rst
+++ b/docs/features/initialization.rst
@@ -133,7 +133,7 @@ override:
command via ``self`` (Default: ``False``)
- **macros**: dictionary of macro names and their values
- **max_completion_items**: max number of CompletionItems to display during
- tab-completion (Default: 50)
+ tab completion (Default: 50)
- **pager**: sets the pager command used by the ``Cmd.ppaged()`` method for
displaying wrapped output using a pager
- **pager_chop**: sets the pager command used by the ``Cmd.ppaged()`` method
diff --git a/docs/features/os.rst b/docs/features/os.rst
index 89905d17..77bc6a66 100644
--- a/docs/features/os.rst
+++ b/docs/features/os.rst
@@ -20,7 +20,7 @@ to type::
(Cmd) !ls -al
-NOTE: ``cmd2`` provides user-friendly tab-completion throughout the process of
+NOTE: ``cmd2`` provides user-friendly tab completion throughout the process of
running a shell command - first for the shell command name itself, and then for
file paths in the argument section.
diff --git a/docs/features/scripting.rst b/docs/features/scripting.rst
index 62af2e6d..1128f5e1 100644
--- a/docs/features/scripting.rst
+++ b/docs/features/scripting.rst
@@ -34,7 +34,7 @@ Running Command Scripts
Command script files can be executed using the built-in ``run_script`` command
or ``@`` shortcut. Both ASCII and UTF-8 encoded unicode text files are
-supported. The ``run_script`` command supports tab-completion of file system
+supported. The ``run_script`` command supports tab completion of file system
paths. There is a variant ``_relative_run_script`` command or ``@@``
shortcut for use within a script which uses paths relative to the first script.
@@ -73,7 +73,7 @@ using ``run_pyscript`` is shown below along with the arg_printer_ script::
arg 2: 'bar'
arg 3: 'baz 23'
-``run_pyscript`` supports tab-completion of file system paths, and as shown
+``run_pyscript`` supports tab completion of file system paths, and as shown
above it has the ability to pass command-line arguments to the scripts invoked.
Python scripts executed with ``run_pyscript`` can run ``cmd2`` application
diff --git a/docs/features/settings.rst b/docs/features/settings.rst
index 5a4a9c0f..aa3e5cec 100644
--- a/docs/features/settings.rst
+++ b/docs/features/settings.rst
@@ -89,11 +89,11 @@ max_completion_items
~~~~~~~~~~~~~~~~~~~~
Maximum number of CompletionItems to display during tab completion. A
-CompletionItem is a special kind of tab-completion hint which displays both a
+CompletionItem is a special kind of tab completion hint which displays both a
value and description and uses one line for each hint. Tab complete the ``set``
command for an example.
-If the number of tab-completion hints exceeds ``max_completion_items``, then
+If the number of tab completion hints exceeds ``max_completion_items``, then
they will be displayed in the typical columnized format and will not include
the description text of the CompletionItem.