docs: mention issue with file lock

Signed-off-by: Stephen L. <[email protected]>
lrq3000 · Aug 15, 2023 · d8a0b49 · d8a0b49
1 parent d5612a6
commit d8a0b49
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -249,13 +249,20 @@ Parameters:
     can be found on your system). Dumb DBM should work on
     any platform, it is native to Python.
     [default : False]
+* readonly : bool, optional
+    Open the database as read-only.
+    [default : False]
 
 Returns:
 
 * out  : dict-like object.
 
+Notes:
+
+* On Linux and MacOS, make sure to only open once each database file, there cannot be two handles pointing to the same file, this will cause a "gdm.error: resource temporarily unavailable" exception!
+
 LICENCE
--------------
+-------
 
 This library is licensed under the MIT License and was created by Stephen Karl Larroque.
 

diff --git a/src/fdict/fdict.py b/src/fdict/fdict.py
@@ -889,6 +889,10 @@ def __init__(self, *args, **kwargs):
         Returns
         -------
         out  : dict-like object.
+
+        Notes
+        -----
+        On Linux and MacOS, make sure to only open once each database file, there cannot be two handles pointing to the same file, this will cause a "gdm.error: resource temporarily unavailable" exception!
         '''
         # Initialize specific arguments for sfdict
         if 'filename' in kwargs and kwargs['filename']: