https://github.com/python/cpython/commit/ffa282cc359d9a8f9f160673cf3eaf13149a82cd
commit: ffa282cc359d9a8f9f160673cf3eaf13149a82cd
branch: 3.12
author: Miss Islington (bot) <[email protected]>
committer: pablogsal <[email protected]>
date: 2024-08-25T22:57:16Z
summary:

[3.12] gh-82378: Document the difference between sys.tracebacklimit and the 
limit arguments (GH-123286) (#123326)

gh-82378: Document the difference between sys.tracebacklimit and the limit 
arguments (GH-123286)
(cherry picked from commit 70bfef52b5734d6cd81c5e8ca9eaf85658916b04)

Co-authored-by: CF Bolz-Tereick <[email protected]>

files:
M Doc/library/traceback.rst

diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst
index 85dae82104a2dc..d3f47b9e4fb596 100644
--- 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.
 

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]

Reply via email to