Skip to content

Commit 8c43385

Browse files
committed
Add documentation note about raw strings.
1 parent 8ca652c commit 8c43385

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

tox_recreate_hook/hooks.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,22 @@
3939

4040

4141
def rmdir(path: PathLike) -> str:
42-
"""
42+
r"""
4343
Remove the given directory and its contents.
4444
4545
:param path:
4646
4747
: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+
4858
"""
4959

5060
path = PathPlus(path)

0 commit comments

Comments
 (0)