Skip to content

Commit 2fabe71

Browse files
committed
Further document cygpath test parameter collections
1 parent a09e538 commit 2fabe71

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Diff for: test/test_util.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -258,14 +258,15 @@ def _xfail_param(*values, **xfail_kwargs):
258258
(R"D:/Apps\fOO", "/cygdrive/d/Apps/fOO"),
259259
(R"D:\Apps/123", "/cygdrive/d/Apps/123"),
260260
)
261+
"""Path test cases for cygpath and decygpath, other than extended UNC paths."""
261262

262263
_unc_cygpath_pairs = (
263264
(R"\\?\a:\com", "/cygdrive/a/com"),
264265
(R"\\?\a:/com", "/cygdrive/a/com"),
265266
(R"\\?\UNC\server\D$\Apps", "//server/D$/Apps"),
266267
)
268+
"""Extended UNC path test cases for cygpath."""
267269

268-
# Mapping of expected failures for the test_cygpath_ok test.
269270
_cygpath_ok_xfails = {
270271
# From _norm_cygpath_pairs:
271272
(R"C:\Users", "/cygdrive/c/Users"): "/proc/cygdrive/c/Users",
@@ -279,9 +280,9 @@ def _xfail_param(*values, **xfail_kwargs):
279280
(R"\\?\a:\com", "/cygdrive/a/com"): "/proc/cygdrive/a/com",
280281
(R"\\?\a:/com", "/cygdrive/a/com"): "/proc/cygdrive/a/com",
281282
}
283+
"""Mapping of expected failures for the test_cygpath_ok test."""
282284

283285

284-
# Parameter sets for the test_cygpath_ok test.
285286
_cygpath_ok_params = [
286287
(
287288
_xfail_param(*case, reason=f"Returns: {_cygpath_ok_xfails[case]!r}", raises=AssertionError)
@@ -290,6 +291,7 @@ def _xfail_param(*values, **xfail_kwargs):
290291
)
291292
for case in _norm_cygpath_pairs + _unc_cygpath_pairs
292293
]
294+
"""Parameter sets for the test_cygpath_ok test."""
293295

294296

295297
@pytest.mark.skipif(sys.platform != "cygwin", reason="Paths specifically for Cygwin.")

0 commit comments

Comments
 (0)