Enable use as a context decorator (documentation) (tox-dev#127)

hirschalter · Jan 3, 2022 · 869d129 · 869d129
1 parent fcb4e21
commit 869d129
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -67,6 +67,12 @@ locks:
     finally:
         lock.release()
 
+    @lock
+    def decorated():
+        open(file_path, "a").write("You're a decorated Jedi!")
+
+    decorated()
+
 The :meth:`acquire <filelock.BaseFileLock.acquire>` method accepts also a ``timeout`` parameter. If the lock cannot be
 acquired within ``timeout`` seconds, a :class:`Timeout <filelock.Timeout>` exception is raised: