summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2019-03-10 14:01:52 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2019-03-10 14:01:52 -0400
commit16a337dfa4b96d57f0dc9e2e31e2eb99330f673b (patch)
tree277bf52a39593799d919dc2bbb1dd054b514d448
parentcd5bfb53dafc99006d4052f889ac80e7ca73c408 (diff)
downloadcmd2-git-16a337dfa4b96d57f0dc9e2e31e2eb99330f673b.tar.gz
Removed obsolete documentation
-rw-r--r--docs/freefeatures.rst20
1 files changed, 2 insertions, 18 deletions
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst
index 5c246798..bcb9c0e7 100644
--- a/docs/freefeatures.rst
+++ b/docs/freefeatures.rst
@@ -130,29 +130,13 @@ debugging your application. To prevent users from enabling this ability
manually you'll need to remove ``locals_in_py`` from the ``settable`` dictionary.
The ``app`` object (or your custom name) provides access to application commands
-through either raw commands or through a python API wrapper. For example, any
-application command call be called with ``app("<command>")``. All application
-commands are accessible as python objects and functions matching the command
-name. For example, the following are equivalent:
+through raw commands. For example, any application command call be called with
+``app("<command>")``.
::
>>> app('say --piglatin Blah')
lahBay
- >>> app.say("Blah", piglatin=True)
- lahBay
-
-
-Sub-commands are also supported. The following pairs are equivalent:
-
-::
-
- >>> app('command subcmd1 subcmd2 param1 --myflag --otherflag 3')
- >>> app.command.subcmd1.subcmd2('param1', myflag=True, otherflag=3)
-
- >>> app('command subcmd1 param1 subcmd2 param2 --myflag --otherflag 3')
- >>> app.command.subcmd1('param1').subcmd2('param2', myflag=True, otherflag=3)
-
More Python examples: