[Python-checkins] r75510 - in python/trunk: Doc/c-api/float.rst Misc/NEWS

[eric.smith]

Author: eric.smith
Date: Mon Oct 19 16:38:14 2009
New Revision: 75510

Log:
Issue #7169: Document PyFloat_AsString and PyFloat_AsReprString, and note that they are unsafe and deprecated.

Modified:
   python/trunk/Doc/c-api/float.rst
   python/trunk/Misc/NEWS

Modified: python/trunk/Doc/c-api/float.rst
==============================================================================
--- python/trunk/Doc/c-api/float.rst	(original)
+++ python/trunk/Doc/c-api/float.rst	Mon Oct 19 16:38:14 2009
@@ -92,3 +92,27 @@
    be freed.
 
    .. versionadded:: 2.6
+
+
+.. cfunction:: void PyFloat_AsString(char *buf, PyFloatObject *v)
+
+   Convert the argument *v* to a string, using the same rules as
+   :func:`str`. The length of *buf* should be at least 100.
+
+   This function is unsafe to call because it writes to a buffer whose
+   length it does not know.
+
+   .. deprecated:: 2.7
+      Use :func:`PyObject_Str` or :func:`PyOS_double_to_string` instead.
+
+
+.. cfunction:: void PyFloat_AsReprString(char *buf, PyFloatObject *v)
+
+   Same as PyFloat_AsString, except uses the same rules as
+   :func:`repr`.  The length of *buf* should be at least 100.
+
+   This function is unsafe to call because it writes to a buffer whose
+   length it does not know.
+
+   .. deprecated:: 2.7
+      Use :func:`PyObject_Repr` or :func:`PyOS_double_to_string` instead.

Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS	(original)
+++ python/trunk/Misc/NEWS	Mon Oct 19 16:38:14 2009
@@ -12,6 +12,9 @@
 Core and Builtins
 -----------------
 
+- Issue #7168: Document PyFloat_AsString and PyFloat_AsReprString, and
+  note that they are unsafe and deprecated.
+
 - Issue #7120: logging: Removed import of multiprocessing which is causing
   crash in GAE.