Merge pull request #185 from gerlero/files

Fix docstring
gerlero · Sep 20, 2024 · c7f9fa1 · c7f9fa1
2 parents 594d343 + 6053cd4
commit c7f9fa1
Showing 1 changed file with 3 additions and 7 deletions.
diff --git a/foamlib/_files/_files.py b/foamlib/_files/_files.py
@@ -105,13 +105,9 @@ def create(self, *, exist_ok: bool = False, parents: bool = False) -> Self:
         """
         Create the file.
 
-        Parameters
-        ----------
-        exist_ok : bool, optional
-            If False (the default), raise a FileExistsError if the file already exists.
-            If True, do nothing if the file already exists.
-        parents : bool, optional
-            If True, also create parent directories as needed.
+        :param exist_ok: If False, raise a FileExistsError if the file already exists.
+
+        :param parents: If True, also create parent directories as needed.
         """
         if self.path.exists():
             if not exist_ok: