summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1997-03-03 16:01:21 (GMT)
committerGuido van Rossum <guido@python.org>1997-03-03 16:01:21 (GMT)
commitcda3d7d0e7c5a507bee1ee1610745271af25dea9 (patch)
tree19fba84f185cd98d48ec25c7f7a9fe4734fdf518
parent20e4210ec4b7303f966939484c0d0023060cc442 (diff)
downloadcpython-cda3d7d0e7c5a507bee1ee1610745271af25dea9.zip
cpython-cda3d7d0e7c5a507bee1ee1610745271af25dea9.tar.gz
cpython-cda3d7d0e7c5a507bee1ee1610745271af25dea9.tar.bz2
Added (minimal) StringIO docs.
-rw-r--r--Doc/Makefile2
-rw-r--r--Doc/lib.tex1
-rw-r--r--Doc/lib/lib.tex1
-rw-r--r--Doc/lib/libstrio.tex14
-rw-r--r--Doc/libstrio.tex14
5 files changed, 31 insertions, 1 deletions
diff --git a/Doc/Makefile b/Doc/Makefile
index 2407b9b..a244f9e 100644
--- a/Doc/Makefile
+++ b/Doc/Makefile
@@ -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)
diff --git a/Doc/lib.tex b/Doc/lib.tex
index a7c86d7..66c6b0c 100644
--- a/Doc/lib.tex
+++ b/Doc/lib.tex
@@ -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/lib.tex b/Doc/lib/lib.tex
index a7c86d7..66c6b0c 100644
--- a/Doc/lib/lib.tex
+++ b/Doc/lib/lib.tex
@@ -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
index 0000000..fdf973f
--- /dev/null
+++ b/Doc/lib/libstrio.tex
@@ -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
index 0000000..fdf973f
--- /dev/null
+++ b/Doc/libstrio.tex
@@ -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.