]> granicus.if.org Git - python/commitdiff
Added (minimal) StringIO docs.
authorGuido van Rossum <guido@python.org>
Mon, 3 Mar 1997 16:01:21 +0000 (16:01 +0000)
committerGuido van Rossum <guido@python.org>
Mon, 3 Mar 1997 16:01:21 +0000 (16:01 +0000)
Doc/Makefile
Doc/lib.tex
Doc/lib/lib.tex
Doc/lib/libstrio.tex [new file with mode: 0644]
Doc/libstrio.tex [new file with mode: 0644]

index 2407b9b0b839e142bb16f8e6819819b8c0ab9aec..a244f9e146834225b4c73761519fb21b8dab60d5 100644 (file)
@@ -113,7 +113,7 @@ LIBFILES = lib.tex \
     libxdrlib.tex libimghdr.tex \
     librestricted.tex librexec.tex libbastion.tex \
     libformatter.tex liboperator.tex libsoundex.tex libresource.tex \
-    libstat.tex
+    libstat.tex libstrio.tex
 
 # Library document
 lib.dvi: $(LIBFILES)
index a7c86d7e701a8f95aab5211fdba73cf9f8a02b28..66c6b0c68d92ab3413b0da549e9bf98f487a50ba 100644 (file)
@@ -93,6 +93,7 @@ to Python and how to embed it in other applications.
 \input{libregex}
 \input{libregsub}
 \input{libstruct}
+\input{libstrio}
 \input{libsoundex}
 
 \input{libmisc}                        % Miscellaneous Services
index a7c86d7e701a8f95aab5211fdba73cf9f8a02b28..66c6b0c68d92ab3413b0da549e9bf98f487a50ba 100644 (file)
@@ -93,6 +93,7 @@ to Python and how to embed it in other applications.
 \input{libregex}
 \input{libregsub}
 \input{libstruct}
+\input{libstrio}
 \input{libsoundex}
 
 \input{libmisc}                        % Miscellaneous Services
diff --git a/Doc/lib/libstrio.tex b/Doc/lib/libstrio.tex
new file mode 100644 (file)
index 0000000..fdf973f
--- /dev/null
@@ -0,0 +1,14 @@
+\section{Standard Module \sectcode{StringIO}}
+
+\stmodindex{StringIO}
+
+This module implements a file-like class, \code{StringIO},
+that read and write a string buffer (also known as {\em memory
+files}). See the description on file objects for operations.
+
+When a \code{StringIO} object is created, it can be initialized
+to an existing string by passing the string to the constructor.
+If no string is given, the \code{StringIO} will start empty.
+
+The method \code{getvalue()} can be called at any time to return the
+contents of the entire ``file'' at any time.
diff --git a/Doc/libstrio.tex b/Doc/libstrio.tex
new file mode 100644 (file)
index 0000000..fdf973f
--- /dev/null
@@ -0,0 +1,14 @@
+\section{Standard Module \sectcode{StringIO}}
+
+\stmodindex{StringIO}
+
+This module implements a file-like class, \code{StringIO},
+that read and write a string buffer (also known as {\em memory
+files}). See the description on file objects for operations.
+
+When a \code{StringIO} object is created, it can be initialized
+to an existing string by passing the string to the constructor.
+If no string is given, the \code{StringIO} will start empty.
+
+The method \code{getvalue()} can be called at any time to return the
+contents of the entire ``file'' at any time.