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

This commit is contained in:
CF Bolz-Tereick 2024-08-26 00:50:43 +02:00 committed by GitHub
parent fdb3f9b588
commit 70bfef52b5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions

View File

@ -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.