add docs

vstinner · Sep 29, 2024 · Sep 27, 2024 · Sep 27, 2024 · Sep 27, 2024 · Sep 27, 2024
commit 47971e965fb8c1c99301da02bb2473e7463ee9c6
diff --git a/Doc/c-api/codec.rst b/Doc/c-api/codec.rst
@@ -97,6 +97,22 @@ Registry API for Unicode encoding error handlers
 
    Return ``0`` on success, ``-1`` on error.
 
+.. c:function:: int PyCodec_UnregisterError(const char *name)
+
+   Un-register the error handling callback function error under the given error
+   policy *name*. :ref:`Standard error policies <serror-handlers>` cannot be
+   un-registered.
+
+   * Return ``-1`` and set a :exc:`ValueError` exception if *name* is a
+     standard error policy or if an error occurred (in which case the
+     existing exception is propagated).
+
+   * Return ``0`` if no error handler is associated with the given error policy.
+
+   * Return ``1`` if the error handler was successfully removed.
+
+   .. versionadded:: 3.14
+
 .. c:function:: PyObject* PyCodec_LookupError(const char *name)
 
    Lookup the error handling callback function registered under *name*.  As a

diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
@@ -439,6 +439,17 @@ handler:
    replacement from the error handler will be put into the output directly.
 
 
+.. function:: unregister_error(name)
+
+   Attempt to un-register the error handling function under the name *name*.
+
+   This raises a :exc:`ValueError` if *name* denotes a standard error policy
+   as specified above. Otherwise, this returns ``True`` if an error handler
+   existed for the given *name* and ``False`` otherwise.
+
+   .. versionadded:: 3.14
+
+
 Previously registered error handlers (including the standard error handlers)
 can be looked up by name: