Skip to content

Commit f4e5f42

Browse files
committed
Slightly improve docstrings
1 parent d4917d0 commit f4e5f42

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

test/deprecation/test_compat.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Tests for dynamic and static errors and warnings in GitPython's git.compat module.
22
3-
These tests verify that the is_<platform> aliases are available, and are even listed in
4-
the output of dir(), but issue warnings, and that bogus (misspelled or unrecognized)
3+
These tests verify that the is_<platform> attributes are available, and are even listed
4+
in the output of dir(), but issue warnings, and that bogus (misspelled or unrecognized)
55
attribute access is still an error both at runtime and with mypy. This is similar to
66
some of the tests in test_toplevel, but the situation being tested here is simpler
77
because it does not involve unintuitive module aliasing or import behavior. So this only
@@ -15,8 +15,8 @@
1515

1616
import git.compat
1717

18-
1918
_MESSAGE_LEADER = "{} and other is_<platform> aliases are deprecated."
19+
"""Form taken by the beginning of the warnings issues for is_<platform> access."""
2020

2121

2222
def test_cannot_access_undefined() -> None:
@@ -26,7 +26,7 @@ def test_cannot_access_undefined() -> None:
2626

2727

2828
def test_is_platform() -> None:
29-
"""The is_<platform> aliases work, warn, and mypy accepts code accessing them."""
29+
"""The is_<platform> attributes work, warn, and mypy accepts code accessing them."""
3030
fully_qualified_names = [
3131
"git.compat.is_win",
3232
"git.compat.is_posix",

0 commit comments

Comments
 (0)