gh-82378: Document the difference between sys.tracebacklimit and the …

…limit arguments (GH-123286) (cherry picked from commit 70bfef5) Co-authored-by: CF Bolz-Tereick <[email protected]>
python · Aug 25, 2024 · 6c52b1d · 6c52b1d
1 parent e37b7f1
commit 6c52b1d
Showing 1 changed file with 8 additions and 0 deletions.
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.