From: Georg Brandl <georg@python.org>
Date: Wed, 12 Sep 2007 21:29:27 +0000 (+0000)
Subject: Document input() function.
X-Git-Tag: v3.0a2~392
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c09029889ab39120bdaf568ae873a2c40ac16925;p=thirdparty%2FPython%2Fcpython.git

Document input() function.
---

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 601aa3627d58..5f315d876987 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -524,6 +524,22 @@ available.  They are listed here in alphabetical order.
    (Implementation note: this is the address of the object.)
 
 
+.. function:: input([prompt])
+
+   If the *prompt* argument is present, it is written to standard output without
+   a trailing newline.  The function then reads a line from input, converts it
+   to a string (stripping a trailing newline), and returns that.  When EOF is
+   read, :exc:`EOFError` is raised.  Example::
+
+      >>> s = raw_input('--> ')
+      --> Monty Python's Flying Circus
+      >>> s
+      "Monty Python's Flying Circus"
+
+   If the :mod:`readline` module was loaded, then :func:`raw_input` will use it
+   to provide elaborate line editing and history features.
+
+
 .. function:: int([x[, radix]])
 
    Convert a string or number to an integer.  If the argument is a string, it