From: Guido van Rossum <guido@python.org>
Date: Fri, 19 Mar 1999 19:10:14 +0000 (+0000)
Subject: Document new builtin buffer().  Greg Stein.
X-Git-Tag: v1.5.2c1~122
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8be229650dd59c06c369e3ccb5394f9243f78501;p=thirdparty%2FPython%2Fcpython.git

Document new builtin buffer().  Greg Stein.
---

diff --git a/Doc/lib/libfuncs.tex b/Doc/lib/libfuncs.tex
index 210fec4c157e..5870978b71c1 100644
--- a/Doc/lib/libfuncs.tex
+++ b/Doc/lib/libfuncs.tex
@@ -81,6 +81,16 @@ dictionary whose keys are strings.  It specifies keyword arguments to
 be added to the end of the the argument list.
 \end{funcdesc}
 
+\begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}}
+The \var{object} argument must be an object that supports the
+buffer call interface (such as strings, arrays, and buffers). A new
+buffer object will be created which references the \var{object} argument.
+The buffer object will be a slice from the beginning of \var{object}
+(or from the specified \var{offset}). The slice will extend to the
+end of \var{object} (or will have a length given by the \var{size}
+argument).
+\end{funcdesc}
+
 \begin{funcdesc}{callable}{object}
 Return true if the \var{object} argument appears callable, false if
 not.  If this returns true, it is still possible that a call fails,