summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFlaper Fesp <flaper87@gmail.com>2013-06-10 14:09:49 +0200
committerFlaper Fesp <flaper87@gmail.com>2013-06-10 15:47:06 +0200
commitb41862d310164ea91f65abdeaa406617016e9076 (patch)
tree1a8571dbdf6cfbcd3a3dfb1e6379b865d6af6226
parent1f6a66599fd15e95bacd73da16cadeae61f0bb7b (diff)
downloadoslo-b41862d310164ea91f65abdeaa406617016e9076.tar.gz
oslo-b41862d310164ea91f65abdeaa406617016e9076.tar.xz
oslo-b41862d310164ea91f65abdeaa406617016e9076.zip
Use param keyword for docstrings
Change-Id: I381a5f917a1c274634173d843dde730218806506
-rw-r--r--openstack/common/lockutils.py23
1 files changed, 12 insertions, 11 deletions
diff --git a/openstack/common/lockutils.py b/openstack/common/lockutils.py
index 79d1905..27525ce 100644
--- a/openstack/common/lockutils.py
+++ b/openstack/common/lockutils.py
@@ -158,17 +158,18 @@ def synchronized(name, lock_file_prefix, external=False, lock_path=None):
This way only one of either foo or bar can be executing at a time.
- The lock_file_prefix argument is used to provide lock files on disk with a
- meaningful prefix. The prefix should end with a hyphen ('-') if specified.
-
- The external keyword argument denotes whether this lock should work across
- multiple processes. This means that if two different workers both run a
- a method decorated with @synchronized('mylock', external=True), only one
- of them will execute at a time.
-
- The lock_path keyword argument is used to specify a special location for
- external lock files to live. If nothing is set, then CONF.lock_path is
- used as a default.
+ :param lock_file_prefix: The lock_file_prefix argument is used to provide
+ lock files on disk with a meaningful prefix. The prefix should end with a
+ hyphen ('-') if specified.
+
+ :param external: The external keyword argument denotes whether this lock
+ should work across multiple processes. This means that if two different
+ workers both run a a method decorated with @synchronized('mylock',
+ external=True), only one of them will execute at a time.
+
+ :param lock_path: The lock_path keyword argument is used to specify a
+ special location for external lock files to live. If nothing is set, then
+ CONF.lock_path is used as a default.
"""
def wrap(f):