summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-05-31 14:40:09 +0000
committerGeorg Brandl <georg@python.org>2008-05-31 14:40:09 +0000
commita7ac20f8a51e6bb4b13d4f682ce42fe82394e677 (patch)
treea2fb39960653afea329d50a00a6d81696ddf62e6
parent700a6350917ee6a6e760cb357723912588d1af5c (diff)
downloadcpython-git-a7ac20f8a51e6bb4b13d4f682ce42fe82394e677.tar.gz
#3010: clarification about stdin/use_rawinput.
-rw-r--r--Doc/library/cmd.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/library/cmd.rst b/Doc/library/cmd.rst
index 738214f389..5782b5bfae 100644
--- a/Doc/library/cmd.rst
+++ b/Doc/library/cmd.rst
@@ -26,7 +26,12 @@ interface.
The optional arguments *stdin* and *stdout* specify the input and output file
objects that the Cmd instance or subclass instance will use for input and
- output. If not specified, they will default to *sys.stdin* and *sys.stdout*.
+ output. If not specified, they will default to :data:`sys.stdin` and
+ :data:`sys.stdout`.
+
+ If you want a given *stdin* to be used, make sure to set the instance's
+ :attr:`use_rawinput` attribute to ``False``, otherwise *stdin* will be
+ ignored.
.. versionchanged:: 2.3
The *stdin* and *stdout* parameters were added.