From: Eric Smith <eric@trueblade.com>
Date: Mon, 19 Oct 2009 14:38:14 +0000 (+0000)
Subject: Issue #7169: Document PyFloat_AsString and PyFloat_AsReprString, and note that they... 
X-Git-Tag: v2.7a1~306
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c12781abcba0ff9ff5f6f7af807634ea4bc49e49;p=python

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

diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst
index c4099a3057..295fb90d05 100644
--- a/Doc/c-api/float.rst
+++ b/Doc/c-api/float.rst
@@ -92,3 +92,27 @@ Floating Point Objects
    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.
diff --git a/Misc/NEWS b/Misc/NEWS
index f6843259fe..38c29bab6d 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -12,6 +12,9 @@ What's New in Python 2.7 alpha 1
 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.