From b05de437d000545c73d169debe36aff1a7d60edf Mon Sep 17 00:00:00 2001
From: Marc Beninca <git@marc.beninca.link>
Date: Tue, 17 Sep 2024 22:42:19 +0200
Subject: [PATCH] doc/wipe

---
 rwx/fs/__init__.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/rwx/fs/__init__.py b/rwx/fs/__init__.py
index ee1925d..1b9e811 100644
--- a/rwx/fs/__init__.py
+++ b/rwx/fs/__init__.py
@@ -69,7 +69,11 @@ def read_file_text(file_path: Path, charset: str = CHARSET) -> str:
 
 
 def wipe(path: Path) -> None:
-    """Wipe provided path, whether directory or file."""
+    """Wipe provided path, whether directory or file.
+
+    :param path: target path
+    :type path: Path
+    """
     try:
         shutil.rmtree(path)
     except NotADirectoryError: