From: Michael W. Hudson <mwh@python.net>
Date: Mon, 11 Mar 2002 10:02:18 +0000 (+0000)
Subject: backport jhylton's checkin of
X-Git-Tag: v2.2.1c1~88
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8cdebb2e60f864d0fc3b72dab0a7bb87fd8c4663;p=thirdparty%2FPython%2Fcpython.git

backport jhylton's checkin of
    revision 2.33 of cStringIO.c

Fix SF bug #526518

The doc string for cStringIO suggested that str() of a StringIO object
was equivalent to getvalue().  This was never true, so repair the doc
string.  (doctest would have helped here.)

Bug fix candidate for any past versions.
---

diff --git a/Modules/cStringIO.c b/Modules/cStringIO.c
index f85d60ac2b04..8c9dab9680d4 100644
--- a/Modules/cStringIO.c
+++ b/Modules/cStringIO.c
@@ -67,7 +67,7 @@ static char cStringIO_module_documentation[] =
 "  an_output_stream=StringIO()\n"
 "  an_output_stream.write(some_stuff)\n"
 "  ...\n"
-"  value=an_output_stream.getvalue() # str(an_output_stream) works too!\n"
+"  value=an_output_stream.getvalue()\n"
 "\n"
 "  an_input_stream=StringIO(a_string)\n"
 "  spam=an_input_stream.readline()\n"