We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 8ca652c commit 8c43385Copy full SHA for 8c43385
tox_recreate_hook/hooks.py
@@ -39,12 +39,22 @@
39
40
41
def rmdir(path: PathLike) -> str:
42
- """
+ r"""
43
Remove the given directory and its contents.
44
45
:param path:
46
47
:returns: A message in the format :file:`'removing {<path>}'`
48
+
49
+ .. attention::
50
51
+ On Windows-like systems using ``\`` as a path separator
52
+ you may need to use a *raw string* for the path:
53
54
+ .. code-block:: ini
55
56
+ recreate_hook = builtin.rmdir(r"{toxinidir}/doc-source/build")
57
58
"""
59
60
path = PathPlus(path)
0 commit comments