Skip to content

Commit b8ce990

Browse files
committed
Better name and document the basic deprecation test module
The other deprecation test modules this refers to don't exist yet but will be introduced soon.
1 parent 8bbcb26 commit b8ce990

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

Diff for: test/deprecation/test_various.py renamed to test/deprecation/test_basic.py

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4-
"""Tests of assorted deprecation warnings with no extra subtleties to check."""
4+
"""Tests of assorted deprecation warnings when there are no extra subtleties to check.
5+
6+
This tests deprecation warnings where all that needs be verified is that a deprecated
7+
property, function, or class issues a DeprecationWarning when used and, if applicable,
8+
that recommended alternatives do not issue the warning.
9+
10+
This is in contrast to other modules within test.deprecation, which test warnings where
11+
there is a risk of breaking other runtime behavior, or of breaking static type checking
12+
or making it less useful, by introducing the warning or in plausible future changes to
13+
how the warning is implemented. That happens when it is necessary to customize attribute
14+
access on a module or class, in a way it was not customized before, to issue a warning.
15+
It is inapplicable to the deprecations whose warnings are tested in this module.
16+
"""
517

618
import contextlib
719
import warnings

0 commit comments

Comments
 (0)