mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 16:39:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Add more inline documentation, as contributed in #487906.

Browse source
This commit is contained in:
Martin v. Löwis 2001-12-03 08:24:52 +00:00
parent b22c6720aa
commit 8f1ea71eab
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Objects/stringobject.c
View file

@ -33,9 +33,14 @@ static PyStringObject *nullstring;
a NULL first argument, because in the future these routines may try to do
even more sharing of objects.
The parameter `size' denotes number of characters to allocate, not counting
the null terminating character. If the `str' argument is not NULL, then it
must point to a null-terminated string of length `size'.
The string in the `str' parameter does not have to be null-character
terminated. (Therefore it is safe to construct a substring by using
`PyString_FromStringAndSize(origstring, substrlen)'.)
The parameter `size' denotes number of characters to allocate, not
counting the null terminating character. If the `str' argument is
not NULL, then it points to a of length `size'. For
PyString_FromString, this string must be null-terminated.
The member `op->ob_size' denotes the number of bytes of data in the string,
not counting the null terminating character, and is therefore equal to the