From: Andrew M. Kuchling <amk@amk.ca>
Date: Thu, 27 Jul 2006 18:37:33 +0000 (+0000)
Subject: Add example
X-Git-Tag: v2.5b3~134
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9dd8dc3fee7970cbc40b4686957aa3eaf15f91f0;p=python

Add example
---

diff --git a/Doc/lib/libstringio.tex b/Doc/lib/libstringio.tex
index 3992e435e2..24312518f3 100644
--- a/Doc/lib/libstringio.tex
+++ b/Doc/lib/libstringio.tex
@@ -37,6 +37,24 @@ such mixing can cause this method to raise \exception{UnicodeError}.
 Free the memory buffer.
 \end{methoddesc}
 
+Example usage:
+
+\begin{verbatim}
+import StringIO
+
+output = StringIO.StringIO()
+output.write('First line.\n')
+print >>output, 'Second line.'
+
+# Retrieve file contents -- this will be
+# 'First line.\nSecond line.\n'
+contents = output.getvalue()
+
+# Close object and discard memory buffer -- 
+# .getvalue() will now raise an exception.
+output.close()
+\end{verbatim}
+
 
 \section{\module{cStringIO} ---
          Faster version of \module{StringIO}}
@@ -82,3 +100,22 @@ The following data objects are provided as well:
 
 There is a C API to the module as well; refer to the module source for 
 more information.
+
+Example usage:
+
+\begin{verbatim}
+import cStringIO
+
+output = cStringIO.StringIO()
+output.write('First line.\n')
+print >>output, 'Second line.'
+
+# Retrieve file contents -- this will be
+# 'First line.\nSecond line.\n'
+contents = output.getvalue()
+
+# Close object and discard memory buffer -- 
+# .getvalue() will now raise an exception.
+output.close()
+\end{verbatim}
+