]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Document new builtin buffer(). Greg Stein.
authorGuido van Rossum <guido@python.org>
Fri, 19 Mar 1999 19:10:14 +0000 (19:10 +0000)
committerGuido van Rossum <guido@python.org>
Fri, 19 Mar 1999 19:10:14 +0000 (19:10 +0000)
Doc/lib/libfuncs.tex

index 210fec4c157e38b10e37fbd56c6590ab5636fbdd..5870978b71c11a1777589f2a00fdeaa2ed6b3860 100644 (file)
@@ -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,