Move stuff around.

[python_utils.git] / lockfile.py

diff --git a/lockfile.py b/lockfile.py
index 34279ba8392c0e538ede3bfbc09b7af882657c16..b6a832ee0e3a9c5eadb27cc3b1955538fb49c345 100644 (file)
--- a/lockfile.py
+++ b/lockfile.py
@@ -28,9 +28,15 @@ class LockFileContents:
 
 class LockFile(object):
     """A file locking mechanism that has context-manager support so you
-    can use it in a with statement.
-    """
+    can use it in a with statement.  e.g.
+
+    with LockFile('./foo.lock'):
+        # do a bunch of stuff... if the process dies we have a signal
+        # handler to do cleanup.  Other code (in this process or another)
+        # that tries to take the same lockfile will block.  There is also
+        # some logic for detecting stale locks.
 
+    """
     def __init__(
             self,
             lockfile_path: str,