@@ -135,17 +135,20 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
135135 allow_cli_args : bool = True , transcript_files : Optional [List [str ]] = None ,
136136 allow_redirection : bool = True , multiline_commands : Optional [List [str ]] = None ,
137137 terminators : Optional [List [str ]] = None , shortcuts : Optional [Dict [str , str ]] = None ) -> None :
138- """An easy but powerful framework for writing line-oriented command interpreters, extends Python's cmd package.
138+ """An easy but powerful framework for writing line-oriented command
139+ interpreters. Extends Python's cmd package.
139140
140141 :param completekey: readline name of a completion key, default to Tab
141142 :param stdin: alternate input file object, if not specified, sys.stdin is used
142143 :param stdout: alternate output file object, if not specified, sys.stdout is used
143144 :param persistent_history_file: file path to load a persistent cmd2 command history from
144- :param persistent_history_length: max number of history items to write to the persistent history file
145+ :param persistent_history_length: max number of history items to write
146+ to the persistent history file
145147 :param startup_script: file path to a script to execute at startup
146148 :param use_ipython: should the "ipy" command be included for an embedded IPython shell
147149 :param allow_cli_args: if ``True``, then :meth:`cmd2.Cmd.__init__` will process command
148- line arguments as either commands to be run or, if ``-t`` or ``--test`` are given, transcript files to run. This should be
150+ line arguments as either commands to be run or, if ``-t`` or
151+ ``--test`` are given, transcript files to run. This should be
149152 set to ``False`` if your application parses its own command line
150153 arguments.
151154 :param transcript_files: pass a list of transcript files to be run on initialization.
@@ -158,13 +161,15 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
158161 redirection and piping tokens, and they will be parsed as such
159162 but they won't do anything.
160163 :param multiline_commands: list of commands allowed to accept multi-line input
161- :param terminators: list of characters that terminate a command. These are mainly intended for terminating
162- multiline commands, but will also terminate single-line commands. If not supplied, then
163- defaults to semicolon. If your app only contains single-line commands and you want
164- terminators to be treated as literals by the parser, then set this to an empty list.
165- :param shortcuts: dictionary containing shortcuts for commands. If not supplied, then defaults to
166- constants.DEFAULT_SHORTCUTS. If you do not want any shortcuts, pass
167- an empty dictionary.
164+ :param terminators: list of characters that terminate a command. These are mainly
165+ intended for terminating multiline commands, but will also
166+ terminate single-line commands. If not supplied, the default
167+ is a semicolon. If your app only contains single-line commands
168+ and you want terminators to be treated as literals by the parser,
169+ then set this to an empty list.
170+ :param shortcuts: dictionary containing shortcuts for commands. If not supplied,
171+ then defaults to constants.DEFAULT_SHORTCUTS. If you do not want
172+ any shortcuts, pass an empty dictionary.
168173 """
169174 # If use_ipython is False, make sure the ipy command isn't available in this instance
170175 if not use_ipython :
0 commit comments