document 'y(#)' format codes for Py_BuildValue

ffc9479a · Benjamin Peterson · 3851d12f · ffc9479a
Commit ffc9479a authored Oct 21, 2008 by Benjamin Peterson
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 0 deletions

Doc/c-api/arg.rst Doc/c-api/arg.rst +8 -0

No files found.
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -424,6 +424,14 @@ and the following format units are left untouched.
      Convert a C string and its length to a Python object.  If the C string pointer
      is *NULL*, the length is ignored and ``None`` is returned.

+   ``y`` (bytes) [char \*, int]
+      This converts a C string to a Python :func:`bytes` object.  If the C
+      string pointer is *NULL*, ``None`` is returned.
+
+   ``y#`` (bytes) [char \*, int]
+      This converts a C string and its lengths to a Python object.  If the C
+      string pointer is *NULL*, ``None`` is returned.
+
   ``z`` (string or ``None``) [char \*]
      Same as ``s``.