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

1 files changed, 24 insertions, 0 deletions

diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst
index c4099a3..295fb90 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.