Skip to content

Commit f528ab7

Browse files
committed
Updated documentation.
1 parent 604c770 commit f528ab7

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,10 @@
5757
`cmd2_parent_args` parameters, passing parent-level options down without redeclaring them.
5858

5959
- Breaking Changes
60-
- Renamed the `bottom_toolbar` argument in `Cmd.__init__()` to `enable_bottom_toolbar`.
60+
- Renamed the `bottom_toolbar` argument in `Cmd.__init__()` to `enable_bottom_toolbar`. It is
61+
also now strictly an `__init__` parameter and not an instance attribute.
62+
- `complete_in_thread` is now strictly an `__init__` parameter and not an instance attribute of
63+
`Cmd`.
6164
- `get_rprompt()` is now only called if the `enable_rprompt` argument in `Cmd.__init__()` is set
6265
to `True`.
6366

docs/features/initialization.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,12 @@ The `cmd2.Cmd` class provides a large number of public instance attributes which
3434
Here are instance attributes of `cmd2.Cmd` which developers might wish to override:
3535

3636
- **broken_pipe_warning**: if non-empty, this string will be displayed if a broken pipe error occurs
37-
- **complete_in_thread**: if `True`, then completion will run in a separate thread (Default: `True`)
3837
- **continuation_prompt**: used for multiline commands on 2nd+ line of input
3938
- **debug**: if `True`, show full stack trace on error (Default: `False`)
4039
- **default_error**: the error that prints when a non-existent command is run
4140
- **disabled_commands**: commands that have been disabled from use. This is to support commands that are only available during specific states of the application. This dictionary's keys are the command names and its values are DisabledCommand objects.
4241
- **echo**: if `True`, each command the user issues will be repeated to the screen before it is executed. This is particularly useful when running scripts. This behavior does not occur when running a command at the prompt. (Default: `False`)
4342
- **editor**: text editor program to use with _edit_ command (e.g. `vim`)
44-
- **enable_bottom_toolbar**: if `True`, enables a bottom toolbar while at the main prompt. (Default: `False`)
45-
- **enable_rprompt**: if `True`, enables a right prompt while at the main prompt. (Default: `False`)
4643
- **exclude_from_history**: commands to exclude from the _history_ command
4744
- **exit_code**: this determines the value returned by `cmdloop()` when exiting the application
4845
- **help_error**: the error that prints when no help information can be found
@@ -56,7 +53,6 @@ Here are instance attributes of `cmd2.Cmd` which developers might wish to overri
5653
- **py_bridge_name**: name by which embedded Python environments and scripts refer to the `cmd2` application by in order to call commands (Default: `app`)
5754
- **py_locals**: dictionary that defines specific variables/functions available in Python shells and scripts (provides more fine-grained control than making everything available with **self_in_py**)
5855
- **quiet**: if `True`, then completely suppress nonessential output (Default: `False`)
59-
- **refresh_interval**: how often, in seconds, to automatically refresh the UI. (Default: 0.0)
6056
- **scripts_add_to_history**: if `True`, scripts and pyscripts add commands to history (Default: `True`)
6157
- **self_in_py**: if `True`, allow access to your application in _py_ command via `self` (Default: `False`)
6258
- **settable**: dictionary that controls which of these instance attributes are settable at runtime using the _set_ command

0 commit comments

Comments
 (0)