Merged revisions 69520,69633,69672,69703-69704,69717,69731 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r69520 | benjamin.peterson | 2009-02-12 04:50:00 +0100 (Do, 12 Feb 2009) | 1 line
os.fsync() should be used to ensure that data is written to disk
........
r69633 | hirokazu.yamamoto | 2009-02-15 10:19:48 +0100 (So, 15 Feb 2009) | 1 line
Fixed typo.
........
r69672 | benjamin.peterson | 2009-02-16 15:54:34 +0100 (Mo, 16 Feb 2009) | 1 line
note functions that are not aliased to PyBytes_ #5280
........
r69703 | raymond.hettinger | 2009-02-16 23:42:54 +0100 (Mo, 16 Feb 2009) | 3 lines
Issue 5229: Documentation for super() neglects to say what super() actually does
........
r69704 | raymond.hettinger | 2009-02-17 00:00:25 +0100 (Di, 17 Feb 2009) | 1 line
Add explanation for super(type1, type2).
........
r69717 | marc-andre.lemburg | 2009-02-17 13:48:19 +0100 (Di, 17 Feb 2009) | 5 lines
Clarify the deprecation of platform.dist().
Add versionadded tags.
........
r69731 | gregory.p.smith | 2009-02-18 06:46:11 +0100 (Mi, 18 Feb 2009) | 3 lines
Clarify socket timeout behavior vs system network stack behavior on connect
for issue5293.
........
diff --git a/Doc/c-api/string.rst b/Doc/c-api/string.rst
index 156c8f2..c7d27a3 100644
--- a/Doc/c-api/string.rst
+++ b/Doc/c-api/string.rst
@@ -9,8 +9,10 @@
called with a non-string parameter.
.. note::
- These functions have been renamed to PyBytes_* in Python 3.x. The PyBytes
- names are also available in 2.6.
+
+ These functions have been renamed to PyBytes_* in Python 3.x. Unless
+ otherwise noted, the PyBytes functions available in 3.x are aliased to their
+ PyString_* equivalents to help porting.
.. index:: object: string
@@ -238,6 +240,10 @@
reference-count-neutral; you own the object after the call if and only if you
owned it before the call.)
+ .. note::
+
+ This function is not available in 3.x and does not have a PyBytes alias.
+
.. cfunction:: PyObject* PyString_InternFromString(const char *v)
@@ -246,6 +252,10 @@
been interned, or a new ("owned") reference to an earlier interned string object
with the same value.
+ .. note::
+
+ This function is not available in 3.x and does not have a PyBytes alias.
+
.. cfunction:: PyObject* PyString_Decode(const char *s, Py_ssize_t size, const char *encoding, const char *errors)
@@ -255,6 +265,10 @@
The codec to be used is looked up using the Python codec registry. Return
*NULL* if an exception was raised by the codec.
+ .. note::
+
+ This function is not available in 3.x and does not have a PyBytes alias.
+
.. versionchanged:: 2.5
This function used an :ctype:`int` type for *size*. This might require
changes in your code for properly supporting 64-bit systems.
@@ -268,6 +282,10 @@
The codec to be used is looked up using the Python codec registry. Return *NULL*
if an exception was raised by the codec.
+ .. note::
+
+ This function is not available in 3.x and does not have a PyBytes alias.
+
.. cfunction:: PyObject* PyString_Encode(const char *s, Py_ssize_t size, const char *encoding, const char *errors)
@@ -277,6 +295,10 @@
:meth:`encode` method. The codec to be used is looked up using the Python codec
registry. Return *NULL* if an exception was raised by the codec.
+ .. note::
+
+ This function is not available in 3.x and does not have a PyBytes alias.
+
.. versionchanged:: 2.5
This function used an :ctype:`int` type for *size*. This might require
changes in your code for properly supporting 64-bit systems.
@@ -289,3 +311,7 @@
parameters of the same name in the string :meth:`encode` method. The codec to be
used is looked up using the Python codec registry. Return *NULL* if an exception
was raised by the codec.
+
+ .. note::
+
+ This function is not available in 3.x and does not have a PyBytes alias.