From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 2 Nov 2024 11:45:36 +0000 (+0100)
Subject: [3.12] gh-125761: Clarify repeated warning suppression criteria in warnings module... 
X-Git-Tag: v3.12.8~120
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f4bc64d204dce541c20e1425a3b70cab6e811607;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-125761: Clarify repeated warning suppression criteria in warnings module (gh-126331)

(cherry picked from commit 10eeec2d4ffb6b09a6d925877b6d9ef6aa6bb59d)

Co-authored-by: 고병찬 <70642609+byungchanKo99@users.noreply.github.com>
---

diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst
index 0cd3ca3c9de7..53a402e3fcdd 100644
--- a/Doc/library/warnings.rst
+++ b/Doc/library/warnings.rst
@@ -178,6 +178,19 @@ If a warning is reported and doesn't match any registered filter then the
 "default" action is applied (hence its name).
 
 
+
+.. _repeated-warning-suppression-criteria:
+
+Repeated Warning Suppression Criteria
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The filters that suppress repeated warnings apply the following criteria to determine if a warning is considered a repeat:
+
+- ``"default"``: A warning is considered a repeat only if the (*message*, *category*, *module*, *lineno*) are all the same.
+- ``"module"``: A warning is considered a repeat if the (*message*, *category*, *module*) are the same, ignoring the line number.
+- ``"once"``: A warning is considered a repeat if the (*message*, *category*) are the same, ignoring the module and line number.
+
+
 .. _describing-warning-filters:
 
 Describing Warning Filters