diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-02-27 09:53:11 -0500 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-02-27 09:53:11 -0500 |
| commit | 5c23a4b66dff02e62f57e416319fc221ebeac291 (patch) | |
| tree | 835f6e936fa35da2f85ddbc2cd500bfd2fefa38e /docs/transcript.rst | |
| parent | b9a98aa3412b4c0882b2e3bb89c8a10463e93c97 (diff) | |
| parent | 0ee3d6bf3cd20877870d9542d858f8abb1e7f4f1 (diff) | |
| download | cmd2-git-5c23a4b66dff02e62f57e416319fc221ebeac291.tar.gz | |
Merge branch 'master' into unused_and_edit_fixes
Diffstat (limited to 'docs/transcript.rst')
| -rw-r--r-- | docs/transcript.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/transcript.rst b/docs/transcript.rst index a2db3efd..36b35fcf 100644 --- a/docs/transcript.rst +++ b/docs/transcript.rst @@ -26,6 +26,12 @@ A transcript can automatically generated based upon commands previously executed This is by far the easiest way to generate a transcript. +.. warning:: + + Make sure you use the **poutput()** method in your ``cmd2`` application for generating command output. This method + of the ``cmd2.Cmd`` class ensure that output is properly redirected when redirecting to a file, piping to a shell + command, and when generating a transcript. + Manually -------- Here's a transcript created from ``python examples/example.py``:: |