gh-82378: Document the difference between sys.tracebacklimit and the limit arguments (GH-123286)

cfbolz · miss-islington · commit 6c52b1d8c243 · 2024-08-25T22:50:54.000Z
(cherry picked from commit 70bfef5) Co-authored-by: CF Bolz-Tereick <cfbolz@gmx.de>
diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst
@@ -42,6 +42,14 @@ The module defines the following functions:
    :term:`file <file object>` or :term:`file-like object` to
    receive the output.
 
+   .. note::
+
+      The meaning of the *limit* parameter is different than the meaning
+      of :const:`sys.tracebacklimit`. A negative *limit* value corresponds to
+      a positive value of :const:`!sys.tracebacklimit`, whereas the behaviour of
+      a positive *limit* value cannot be achieved with
+      :const:`!sys.tracebacklimit`.
+
    .. versionchanged:: 3.5
        Added negative *limit* support.
 
