python / python/cpython

Setting sys.tracebacklimit to None is not documented

Open
#127,555 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Documentation

From Misc/NEWS.d/3.6.4rc1:

Fixed several issues in printing tracebacks (PyTraceBack_Print()). Setting sys.tracebacklimit to 0 or less now suppresses printing tracebacks. Setting sys.tracebacklimit to None now causes using the default limit. Setting sys.tracebacklimit to an integer larger than LONG_MAX now means using the limit LONG_MAX rather than the default limit.

That it's possible to set sys.tracebacklimit to None is not documented at https://docs.python.org/3/library/sys.html#sys.tracebacklimit.

Noticed by @tungol in python/typeshed#13173.

Linked PRs
  • gh-127556

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the sys.tracebacklimit entry in the Python documentation linked in the issue and compare it with the behavior described in Misc/NEWS.d/3.6.4rc1. Document that setting sys.tracebacklimit to None uses the default limit, then verify the wording against the linked PR gh-127556.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.