[Python-checkins] bpo-40428: Remove references to Py*_ClearFreeList in the docs (GH-19783)

[Zackery Spytz]

https://github.com/python/cpython/commit/bb4a585d903e7fe0a46ded8c2ee3f47435ad6a66
commit: bb4a585d903e7fe0a46ded8c2ee3f47435ad6a66
branch: master
author: Zackery Spytz <zspytz at gmail.com>
committer: GitHub <noreply at github.com>
date: 2020-04-29T04:41:56+02:00
summary:

bpo-40428: Remove references to Py*_ClearFreeList in the docs (GH-19783)

They were removed from the C API in commit
ae00a5a88534fd45939f86c12e038da9fa6f9ed6.

files:
M Doc/c-api/contextvars.rst
M Doc/c-api/dict.rst
M Doc/c-api/float.rst
M Doc/c-api/list.rst
M Doc/c-api/method.rst
M Doc/c-api/set.rst
M Doc/c-api/tuple.rst

diff --git a/Doc/c-api/contextvars.rst b/Doc/c-api/contextvars.rst
index 38256a3b0f2a0..9c088814314a8 100644
--- a/Doc/c-api/contextvars.rst
+++ b/Doc/c-api/contextvars.rst
@@ -101,11 +101,6 @@ Context object management functions:
    current context for the current thread.  Returns ``0`` on success,
    and ``-1`` on error.
 
-.. c:function:: int PyContext_ClearFreeList()
-
-   Clear the context variable free list. Return the total number of
-   freed items.  This function always succeeds.
-
 
 Context variable functions:
 
diff --git a/Doc/c-api/dict.rst b/Doc/c-api/dict.rst
index e48c11d336b8c..2fb29cdd61778 100644
--- a/Doc/c-api/dict.rst
+++ b/Doc/c-api/dict.rst
@@ -232,10 +232,3 @@ Dictionary Objects
           for key, value in seq2:
               if override or key not in a:
                   a[key] = value
-
-
-.. c:function:: int PyDict_ClearFreeList()
-
-   Clear the free list. Return the total number of freed items.
-
-   .. versionadded:: 3.3
diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst
index bfc28a79ecfdc..b29937dbecdcf 100644
--- a/Doc/c-api/float.rst
+++ b/Doc/c-api/float.rst
@@ -76,8 +76,3 @@ Floating Point Objects
 .. c:function:: double PyFloat_GetMin()
 
    Return the minimum normalized positive float *DBL_MIN* as C :c:type:`double`.
-
-.. c:function:: int PyFloat_ClearFreeList()
-
-   Clear the float free list. Return the number of items that could not
-   be freed.
diff --git a/Doc/c-api/list.rst b/Doc/c-api/list.rst
index b247cdfba0187..0bc0785f200d4 100644
--- a/Doc/c-api/list.rst
+++ b/Doc/c-api/list.rst
@@ -142,10 +142,3 @@ List Objects
 
    Return a new tuple object containing the contents of *list*; equivalent to
    ``tuple(list)``.
-
-
-.. c:function:: int PyList_ClearFreeList()
-
-   Clear the free list. Return the total number of freed items.
-
-   .. versionadded:: 3.3
diff --git a/Doc/c-api/method.rst b/Doc/c-api/method.rst
index b1862d796c9f4..0a5341cbbdf15 100644
--- a/Doc/c-api/method.rst
+++ b/Doc/c-api/method.rst
@@ -92,9 +92,3 @@ no longer available.
 .. c:function:: PyObject* PyMethod_GET_SELF(PyObject *meth)
 
    Macro version of :c:func:`PyMethod_Self` which avoids error checking.
-
-
-.. c:function:: int PyMethod_ClearFreeList()
-
-   Clear the free list. Return the total number of freed items.
-
diff --git a/Doc/c-api/set.rst b/Doc/c-api/set.rst
index 54819e8fd6cbd..879f394d966cd 100644
--- a/Doc/c-api/set.rst
+++ b/Doc/c-api/set.rst
@@ -157,10 +157,3 @@ subtypes but not for instances of :class:`frozenset` or its subtypes.
 .. c:function:: int PySet_Clear(PyObject *set)
 
    Empty an existing set of all elements.
-
-
-.. c:function:: int PySet_ClearFreeList()
-
-   Clear the free list. Return the total number of freed items.
-
-   .. versionadded:: 3.3
diff --git a/Doc/c-api/tuple.rst b/Doc/c-api/tuple.rst
index 62bc9a565071d..c14cb2d38fd54 100644
--- a/Doc/c-api/tuple.rst
+++ b/Doc/c-api/tuple.rst
@@ -111,11 +111,6 @@ Tuple Objects
    raises :exc:`MemoryError` or :exc:`SystemError`.
 
 
-.. c:function:: int PyTuple_ClearFreeList()
-
-   Clear the free list. Return the total number of freed items.
-
-
 Struct Sequence Objects
 -----------------------