[Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.114,1.115

[Greg Stein]

Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv22649

Modified Files:
	api.tex 
Log Message:
Correct the documentation for getreadbufferproc and getwritebufferproc.

Fixes bug #233308 from Travis Oliphant.



Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.114
retrieving revision 1.115
diff -C2 -r1.114 -r1.115
*** api.tex	2001/04/04 01:25:17	1.114
--- api.tex	2001/04/07 16:14:49	1.115
***************
*** 4972,4984 ****
  \code{-1}.  The \var{segment} which is passed must be zero or
  positive, and strictly less than the number of segments returned by
! the \member{bf_getsegcount} slot function.  On success, returns
! \code{0} and sets \code{*\var{ptrptr}} to a pointer to the buffer
! memory.
  \end{ctypedesc}
  
  \begin{ctypedesc}[getwritebufferproc]{int (*getwritebufferproc)
                              (PyObject *self, int segment, void **ptrptr)}
! Return a pointer to a writable memory buffer in \code{*\var{ptrptr}};
! the memory buffer must correspond to buffer segment \var{segment}.
  Must return \code{-1} and set an exception on error.
  \exception{TypeError} should be raised if the object only supports
--- 4972,4985 ----
  \code{-1}.  The \var{segment} which is passed must be zero or
  positive, and strictly less than the number of segments returned by
! the \member{bf_getsegcount} slot function.  On success, it returns the
! length of the buffer memory, and sets \code{*\var{ptrptr}} to a
! pointer to that memory.
  \end{ctypedesc}
  
  \begin{ctypedesc}[getwritebufferproc]{int (*getwritebufferproc)
                              (PyObject *self, int segment, void **ptrptr)}
! Return a pointer to a writable memory buffer in \code{*\var{ptrptr}},
! and the length of that segment as the function return value.
! The memory buffer must correspond to buffer segment \var{segment}.
  Must return \code{-1} and set an exception on error.
  \exception{TypeError} should be raised if the object only supports