[Python-checkins] r63830 - python/trunk/Doc/library/cmd.rst

[georg.brandl]

Author: georg.brandl
Date: Sat May 31 16:40:09 2008
New Revision: 63830

Log:
#3010: clarification about stdin/use_rawinput.


Modified:
   python/trunk/Doc/library/cmd.rst

Modified: python/trunk/Doc/library/cmd.rst
==============================================================================
--- python/trunk/Doc/library/cmd.rst	(original)
+++ python/trunk/Doc/library/cmd.rst	Sat May 31 16:40:09 2008
@@ -26,7 +26,12 @@
 
    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.