summary refs log tree commit diff stats
path: root/lib/core/locks.nim
diff options
context:
space:
mode:
Diffstat (limited to 'lib/core/locks.nim')
-rw-r--r--lib/core/locks.nim2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/core/locks.nim b/lib/core/locks.nim
index ba756a863..66e0ab520 100644
--- a/lib/core/locks.nim
+++ b/lib/core/locks.nim
@@ -56,6 +56,8 @@ proc signal*(cond: var Cond) {.inline.} =
   signalSysCond(cond)
 
 template withLock*(a: Lock, body: untyped) =
+  ## Acquires the given lock, executes the statements in body and
+  ## releases the lock after the statements finish executing.
   a.acquire()
   {.locks: [a].}:
     try: