diff options
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..184f129d 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, pipeing to a shell + command, and when generating a transcript. + Manually -------- Here's a transcript created from ``python examples/example.py``:: |