diff options
author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-05-20 23:47:50 -0400 |
---|---|---|
committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-05-20 23:47:50 -0400 |
commit | 2f0dbf5bad19d96880e2ef795660db1b8f04cdc7 (patch) | |
tree | 2d3ef06b705d8347fac5c9a7fe73f472973c4a41 /docs | |
parent | 1fd474fc11d22e0c1201784cf4602139e3f7c637 (diff) | |
download | cmd2-git-2f0dbf5bad19d96880e2ef795660db1b8f04cdc7.tar.gz |
Refactor exit_code implementation
cmd2.Cmd.cmdloop() now returns self.exit_code which should be an integer
Also:
- Refactored examples to call sys.exit(app.cmdloop()) in their __main__
- Running transcript tests now sets the exit_code accordingly based on success/failure
- Updated CHANGELOG
- Updated README
- Updated Sphinx docs
- Added unit test for case when transcript test fails
Diffstat (limited to 'docs')
-rw-r--r-- | docs/unfreefeatures.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 071a15b2..81be76d8 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -204,8 +204,8 @@ Presents numbered options to user, as bash ``select``. Exit code to shell ================== The ``self.exit_code`` attribute of your ``cmd2`` application controls -what exit code is sent to the shell when your application exits from -``cmdloop()``. +what exit code is returned from ``cmdloop()`` when it completes. It is your job to make sure that +this exit code gets sent to the shell when your application exits by calling ``sys.exit(app.cmdloop())``. Asynchronous Feedback |