Skip to content

Commit 8ec8133

Browse files
committed
Add docstring
1 parent 159cd69 commit 8ec8133

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

fsspec/implementations/chained.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,17 @@
66

77

88
class ChainedFileSystem(AbstractFileSystem):
9+
"""Chained filesystem base class.
10+
11+
A chained filesystem is designed to be layered over another FS.
12+
This is useful to implement things like caching.
13+
14+
This base class does very little on its own, but is used as a marker
15+
that the class is designed for chaining.
16+
17+
Right now this is only used in `url_to_fs` to provide the path argument
18+
(`fo`) to the chained filesystem from the underlying filesystem.
19+
20+
Additional functionality may be added in the future.
21+
"""
922
protocol: ClassVar[str] = "chained"

0 commit comments

Comments
 (0)