summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorCF Bolz-Tereick <cfbolz@gmx.de>2024-08-25 22:50:43 (GMT)
committerGitHub <noreply@github.com>2024-08-25 22:50:43 (GMT)
commit70bfef52b5734d6cd81c5e8ca9eaf85658916b04 (patch)
treead493b4cfb5d9c163bfc8fd0dd1fbc3f74a6cc00 /Doc
parentfdb3f9b588f58f3cf95fe1dbf6e5b61ef525a351 (diff)
downloadcpython-70bfef52b5734d6cd81c5e8ca9eaf85658916b04.zip
cpython-70bfef52b5734d6cd81c5e8ca9eaf85658916b04.tar.gz
cpython-70bfef52b5734d6cd81c5e8ca9eaf85658916b04.tar.bz2
gh-82378: Document the difference between sys.tracebacklimit and the limit arguments (#123286)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/traceback.rst8
1 files changed, 8 insertions, 0 deletions
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 <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.