[New-bugs-announce] [issue46001] JSON module documentation mentions OverflowError for case that raises RecursionError

[James Gerity]

New submission from James Gerity <snoop.jedi at gmail.com>:

The docstrings for `json.JSONEncoder, json.dump(), json.dumps()` all refer to `OverflowError` when describing the behavior of the `check_circular` parameter, but the module's test of this parameter catches a `RecursionError` and the documentation does make reference to recursion.

Since the fix for bpo-43225 (7b78d43) the string-escaping machinery in `_json.c` is capable of raising OverflowError, but the reference in the documentation predates this addition by quite a long time.

----------
assignee: docs at python
components: Documentation
messages: 407837
nosy: SnoopJeDi, docs at python
priority: normal
severity: normal
status: open
title: JSON module documentation mentions OverflowError for case that raises RecursionError
versions: Python 3.11

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue46001>
_______________________________________