[Python-checkins] bpo-33252: Document that ResourceWarning is ignored by default (GH-30358)

miss-islington webhook-mailer at python.org
Tue Jan 4 06:35:06 EST 2022


https://github.com/python/cpython/commit/b949845b36b999185ed2bdf8a04dca1da39f3002
commit: b949845b36b999185ed2bdf8a04dca1da39f3002
branch: main
author: Hugo van Kemenade <hugovk at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-01-04T03:34:31-08:00
summary:

bpo-33252: Document that ResourceWarning is ignored by default (GH-30358)



`ResourceWarning` is ignored by default.

Document this behaviour, for consistency with others in this table such as `DeprecationWarning`.

Documentation PR can skip NEWS file.

Automerge-Triggered-By: GH:iritkatriel

files:
M Doc/library/warnings.rst

diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst
index fe11aabbcbdd6..289b28229e1a0 100644
--- a/Doc/library/warnings.rst
+++ b/Doc/library/warnings.rst
@@ -105,7 +105,7 @@ The following warnings category classes are currently defined:
 |                                  | :class:`bytes` and :class:`bytearray`.        |
 +----------------------------------+-----------------------------------------------+
 | :exc:`ResourceWarning`           | Base category for warnings related to         |
-|                                  | resource usage.                               |
+|                                  | resource usage (ignored by default).          |
 +----------------------------------+-----------------------------------------------+
 
 .. versionchanged:: 3.7



More information about the Python-checkins mailing list