@@ -108,7 +108,10 @@ override:
108108 support commands that are only available during specific states of the
109109 application. This dictionary's keys are the command names and its values are
110110 DisabledCommand objects.
111- - **echo **: if ``True `` echo command issued into output (Default: ``False ``)
111+ - **echo **: if ``True ``, each command the user issues will be repeated to the
112+ screen before it is executed. This is particularly useful when running
113+ scripts. This behavior does not occur when a running command at the prompt.
114+ (Default: ``False ``)
112115- **editor **: text editor program to use with *edit * command (e.g. ``vim ``)
113116- **exclude_from_history **: commands to exclude from the *history * command
114117- **exit_code **: this determines the value returned by ``cmdloop() `` when
@@ -125,14 +128,15 @@ override:
125128- **locals_in_py **: if ``True `` allow access to your application in *py *
126129 command via ``self `` (Default: ``False ``)
127130- **macros **: dictionary of macro names and their values
128- - **max_completion_items **: max number of items to display during tab-
129- completion (Default: 50)
131+ - **max_completion_items **: max number of CompletionItems to display during
132+ tab- completion (Default: 50)
130133- **pager **: sets the pager command used by the ``Cmd.ppaged() `` method for
131134 displaying wrapped output using a pager
132135- **pager_chop **: sets the pager command used by the ``Cmd.ppaged() `` method
133136 for displaying chopped/truncated output using a pager
134137- **py_bridge_name **: name by which embedded Python environments and scripts
135- refer to the ``cmd2 `` application by in order to call commands
138+ refer to the ``cmd2 `` application by in order to call commands (Default:
139+ ``app ``)
136140- **py_locals **: dictionary that defines specific variables/functions available
137141 in Python shells and scripts (provides more fine-grained control than making
138142 everything available with **locals_in_py **)
0 commit comments