Document LargeFiles

2022-07-16 16:22:22 +02:00 · 2022-07-16 16:22:22 +02:00 · d0c5f5b2a4
commit d0c5f5b2a4
parent f7c82ed0fe
1 changed files with 96 additions and 55 deletions
--- a/great_ai/large_file/large_file/large_file_mongo.py
+++ b/great_ai/large_file/large_file/large_file_mongo.py
@ -18,6 +18,14 @@ MONGO_NAME_VERSION_SEPARATOR = "_"


 class LargeFileMongo(LargeFileBase):
+    """LargeFile implementation using GridFS (MongoDB) as a backend.
+
+    Store large files remotely using the familiar API of `open()`. With built-in
+    versioning, pruning and local cache.
+
+    See parent for more details.
+    """
+
    mongo_connection_string = None
    mongo_database = None