bpo-43988: Document test.support.check_disallow_instantiation() (pythonGH-26394)

Erlend Egeberg Aasland · Erlend E. Aasland · commit 6ec00e55588b · 2021-06-23T23:21:41.000+02:00
diff --git a/Doc/library/test.rst b/Doc/library/test.rst
@@ -928,8 +928,16 @@ The :mod:`test.support` module defines the following functions:
    .. versionadded:: 3.10
 
 
+.. function:: check_disallow_instantiation(test_case, tp, *args, **kwds)
+
+   Assert that type *tp* cannot be instantiated using *args* and *kwds*.
+
+   .. versionadded:: 3.11
+
+
 The :mod:`test.support` module defines the following classes:
 
+
 .. class:: SuppressCrashReport()
 
    A context manager used to try to prevent crash dialog popups on tests that
diff --git a/Lib/test/support/__init__.py b/Lib/test/support/__init__.py
@@ -1997,9 +1997,9 @@ def infinite_recursion(max_depth=75):
 
 def check_disallow_instantiation(testcase, tp, *args, **kwds):
     """
-    Helper for testing types with the Py_TPFLAGS_DISALLOW_INSTANTIATION flag.
+    Check that given type cannot be instantiated using *args and **kwds.
 
-    See bpo-43916.
+    See bpo-43916: Add Py_TPFLAGS_DISALLOW_INSTANTIATION type flag.
     """
     msg = f"cannot create '{tp.__module__}\.{tp.__name__}' instances"
     testcase.assertRaisesRegex(TypeError, msg, tp, *args, **kwds)
