From 70bfef52b5734d6cd81c5e8ca9eaf85658916b04 Mon Sep 17 00:00:00 2001 From: CF Bolz-Tereick Date: Mon, 26 Aug 2024 00:50:43 +0200 Subject: gh-82378: Document the difference between sys.tracebacklimit and the limit arguments (#123286) --- Doc/library/traceback.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index bfd2c3e..401e12b 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -42,6 +42,14 @@ The module defines the following functions: :term:`file ` 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. -- cgit v0.12