@@ -350,9 +350,19 @@ def renamed_kwarg_warning(since, old_param_name, new_param_name, removal=""):
350350
351351 Examples
352352 --------
353- @renamed_kwarg('1.4.0', 'old_name', 'new_name')
354- def some_function(new_name=None):
355- pass
353+ >>> @renamed_kwarg_warning("1.4.0", "old_name", "new_name", "1.6.0")
354+ >>> def some_function(new_name=None):
355+ >>> pass
356+ >>> some_function(old_name=1)
357+ Parameter 'old_name' has been renamed since 1.4.0. and
358+ will be removed in 1.6.0. Please use 'new_name' instead.
359+
360+ >>> @renamed_kwarg_warning("1.4.0", "old_name", "new_name")
361+ >>> def some_function(new_name=None):
362+ >>> pass
363+ >>> some_function(old_name=1)
364+ Parameter 'old_name' has been renamed since 1.4.0. and
365+ will be removed soon. Please use 'new_name' instead.
356366 """
357367
358368 def deprecate (func , old = old_param_name , new = new_param_name , since = since ):
@@ -367,8 +377,8 @@ def wrapper(*args, **kwargs):
367377 warnings .warn (
368378 f"Parameter '{ old } ' has been renamed since { since } . "
369379 f"and will be removed "
370- + ("in {removal}. " if removal else "soon. " )
371- + f"Please use '{ new } ' instead." ,
380+ + (f "in { removal } " if removal else "soon" )
381+ + f". Please use '{ new } ' instead." ,
372382 _projectWarning ,
373383 stacklevel = 2 ,
374384 )
0 commit comments