Add docstring to DirFS

martindurant · martindurant · commit 979a5901cba7 · 2023-05-25T12:53:21.000-04:00
diff --git a/fsspec/implementations/dirfs.py b/fsspec/implementations/dirfs.py
@@ -3,6 +3,13 @@
 
 
 class DirFileSystem(AsyncFileSystem):
+    """Directory prefix filesystem
+
+    The DirFileSystem is a filesystem-wrapper. It assumes every path it is dealing with
+    is relative to the `path`. After performing the necessary paths operation it
+    delegates everything to the wrapped filesystem.
+    """
+
     def __init__(
         self,
         path=None,
