Skip to content

Commit fd0974f

Browse files
test-driven-development for the win: unchanged remain properties
Co-Authored-By: Kevin Anderson <[email protected]>
1 parent 65e144b commit fd0974f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

pvlib/tests/test__deprecation.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,25 @@
1111

1212
@pytest.fixture
1313
def renamed_kwarg_func():
14-
"""Returns a function decorated by renamed_kwarg_warning."""
14+
"""Returns a function decorated by renamed_kwarg_warning.
15+
This function is called 'func' and has a docstring equal to 'docstring'.
16+
"""
1517

1618
@_deprecation.renamed_kwarg_warning(
1719
"0.1.0", "old_kwarg", "new_kwarg", "0.2.0"
1820
)
1921
def func(new_kwarg):
22+
"""docstring"""
2023
return new_kwarg
2124

2225
return func
2326

2427

2528
def test_renamed_kwarg_warning(renamed_kwarg_func):
29+
# assert decorated function name and docstring are unchanged
30+
assert renamed_kwarg_func.__name__ == "func"
31+
assert renamed_kwarg_func.__doc__ == "docstring"
32+
2633
# assert no warning is raised when using the new kwarg
2734
with warnings.catch_warnings():
2835
warnings.simplefilter("error")

0 commit comments

Comments
 (0)