From: Peter Bierma <zintensitydev@gmail.com>
Date: Fri, 7 Nov 2025 16:19:14 +0000 (-0500)
Subject: gh-141004: Document `PyErr_WarnExplicitFormat` (GH-141187)
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;p=thirdparty%2FPython%2Fcpython.git

gh-141004: Document `PyErr_WarnExplicitFormat` (GH-141187)
---

diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 9c75f66f6831..b6f9399337eb 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -394,6 +394,15 @@ an error value).
    .. versionadded:: 3.2
 
 
+.. c:function:: int PyErr_WarnExplicitFormat(PyObject *category, const char *filename, int lineno, const char *module, PyObject *registry, const char *format, ...)
+
+   Similar to :c:func:`PyErr_WarnExplicit`, but uses
+   :c:func:`PyUnicode_FromFormat` to format the warning message. *format* is
+   an ASCII-encoded string.
+
+   .. versionadded:: 3.2
+
+
 .. c:function:: int PyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, const char *format, ...)
 
    Function similar to :c:func:`PyErr_WarnFormat`, but *category* is