docs(gitdb): discourage usage of GitDB type

Byron · Byron · commit 17413029b0f7 · 2015-08-22T16:40:10.000+02:00
diff --git a/gitdb/db/git.py b/gitdb/db/git.py
@@ -22,7 +22,11 @@
 class GitDB(FileDBBase, ObjectDBW, CompoundDB):
 
     """A git-style object database, which contains all objects in the 'objects'
-    subdirectory"""
+    subdirectory
+
+    ``IMPORTANT``: The usage of this implementation is highly discouraged as it fails to release file-handles.
+    This can be a problem with long-running processes and/or big repositories.
+    """
     # Configuration
     PackDBCls = PackedDB
     LooseDBCls = LooseObjectDB
