Commitb8ce990

committed

Better name and document the basic deprecation test module

The other deprecation test modules this refers to don't exist yetbut will be introduced soon.

1 parent8bbcb26 commitb8ce990Copy full SHA for b8ce990

File tree

+13

-1

lines changed

+13

-1

lines changed

Lines changed: 13 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,19 @@`
`1`	`1`	`# This module is part of GitPython and is released under the`
`2`	`2`	`# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/`
`3`	`3`
`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`	`+"""`
`5`	`17`
`6`	`18`	`importcontextlib`
`7`	`19`	`importwarnings`

Comments

(0)