Skip to content

Commit 9985666

Browse files
committed
Updated change log and comment
1 parent 0b0ccc5 commit 9985666

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
input from previous invocations of `cmd2` based apps now shows in the `history` command.
2929
* Text scripts now run immediately instead of adding their commands to `cmdqueue`. This allows easy capture of
3030
the entire script's output.
31+
* Added member to CommandResult called stop which is the return value of onecmd_plus_hooks after it runs the given
32+
command line.
3133
* Breaking changes
3234
* Replaced `unquote_redirection_tokens()` with `unquote_specific_tokens()`. This was to support the fix
3335
that allows terminators in alias and macro values.
@@ -44,7 +46,8 @@
4446
* HistoryItem class is no longer a subclass of `str`. If you are directly accessing the `.history` attribute
4547
of a `cmd2` based app, you will need to update your code to use `.history.get(1).statement.raw` instead.
4648
* Removed internally used `eos` command that was used to keep track of when a text script's commands ended
47-
* Removed cmd2 member called _STOP_AND_EXIT since it was just a boolean value that should always be True
49+
* Removed cmd2 member called _STOP_AND_EXIT since it was just a boolean value that should always be True
50+
* Removed cmd2 member called _should_quit since PyscriptBridge now handles this logic
4851
* **Python 3.4 EOL notice**
4952
* Python 3.4 reached its [end of life](https://www.python.org/dev/peps/pep-0429/) on March 18, 2019
5053
* This is the last release of `cmd2` which will support Python 3.4

cmd2/pyscript_bridge.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class CommandResult(namedtuple_with_defaults('CommandResult', ['stdout', 'stderr
2424
----------------------
2525
stdout: str - output captured from stdout while this command is executing
2626
stderr: str - output captured from stderr while this command is executing. None if no error captured.
27-
stop: bool - return value of the command's corresponding do_* function
27+
stop: bool - return value of onecmd_plus_hooks after it runs the given command line.
2828
data - possible data populated by the command.
2929
3030
Any combination of these fields can be used when developing a scripting API for a given command.

0 commit comments

Comments
 (0)