summaryrefslogtreecommitdiff
path: root/docs/features/help.rst
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2020-01-29 19:24:50 -0500
committerGitHub <noreply@github.com>2020-01-29 19:24:50 -0500
commit6296d413ac1cee3577c19ba2bbf9da56202dc26d (patch)
tree8cacaa6175acde73a861de5cba3919f3963073e2 /docs/features/help.rst
parente87cadfbaeda0bb0197ce959107bda0db89514ea (diff)
parent0196641173d3b4a69876fb4349d6f5caa5603858 (diff)
downloadcmd2-git-6296d413ac1cee3577c19ba2bbf9da56202dc26d.tar.gz
Merge pull request #867 from python-cmd2/discoverable_verbose_help
Make verbose help more discoverable
Diffstat (limited to 'docs/features/help.rst')
-rw-r--r--docs/features/help.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/features/help.rst b/docs/features/help.rst
index 03e0867b..920516f5 100644
--- a/docs/features/help.rst
+++ b/docs/features/help.rst
@@ -12,15 +12,15 @@ Categorizing Commands
By default, the ``help`` command displays::
- Documented commands (type help <topic>):
- ========================================
+ Documented commands (use 'help -v' for verbose/'help <topic>' for details):
+ ===========================================================================
alias help ipy py run_pyscript set shortcuts
edit history macro quit run_script shell
If you have a large number of commands, you can optionally group your commands
into categories. Here's the output from the example ``help_categories.py``::
- Documented commands (type help <topic>):
+ Documented commands (use 'help -v' for verbose/'help <topic>' for details):
Application Management
======================
@@ -90,7 +90,7 @@ Using the ``categorize()`` function:
The ``help`` command also has a verbose option (``help -v`` or ``help
--verbose``) that combines the help categories with per-command Help Messages::
- Documented commands (type help <topic>):
+ Documented commands (use 'help -v' for verbose/'help <topic>' for details):
Application Management
================================================================================