diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-09 11:25:38 -0500 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-09 11:25:38 -0500 |
| commit | 41e9ce2f9aa74cbf4f8a9bc3ebedbf3a573fb996 (patch) | |
| tree | 3c6760eb21838f940ad85844d9f6422206c37974 | |
| parent | 809d6672fc84fde3d9d685df92b0b5dedab41886 (diff) | |
| download | cmd2-git-41e9ce2f9aa74cbf4f8a9bc3ebedbf3a573fb996.tar.gz | |
Added caveat
| -rw-r--r-- | docs/features/help.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/features/help.rst b/docs/features/help.rst index 1a5e7c0b..57aa2187 100644 --- a/docs/features/help.rst +++ b/docs/features/help.rst @@ -52,7 +52,9 @@ Occasionally there might be an unusual circumstance where providing static help text isn't good enough and you want to provide dynamic information in the help text for a command. To meet this need, if a ``help_foo`` method is defined to match the ``do_foo`` method, then that method will be used to provide the help -for command **foo**. +for command **foo**. This dynamic help is only supported for commands which +do not use an ``argparse`` decorator because didn't want different output for +``help cmd`` than for ``cmd -h``. Categorizing Commands --------------------- |