]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
rbd.py: Fix docstring syntax of list_lockers().
authorTommi Virtanen <tv@inktank.com>
Thu, 4 Oct 2012 21:43:15 +0000 (14:43 -0700)
committerTommi Virtanen <tv@inktank.com>
Thu, 4 Oct 2012 21:54:17 +0000 (14:54 -0700)
Signed-off-by: Tommi Virtanen <tv@inktank.com>
src/pybind/rbd.py

index 12584087405d6c6ece64a3a60e22f68c2ed28cfb..1a3f85d84196ef5dca0ffd76f326ec7d596f4951 100644 (file)
@@ -651,12 +651,14 @@ written." % (self.name, ret, length))
         List clients that have locked the image and information
         about the lock.
 
-        :returns: dict - contains keys tag, exclusive, and lockers
-                  tag - the tag associated with the lock
-                        (every additional locker must use the same tag)
-                  exclusive - boolean indicating whether the lock is
-                              exclusive or shared
-                  lockers - a list of (client, cookie, address) tuples
+        :returns: dict - contains the following keys:
+
+                  * ``tag`` - the tag associated with the lock (every
+                    additional locker must use the same tag)
+                  * ``exclusive`` - boolean indicating whether the
+                     lock is exclusive or shared
+                  * ``lockers`` - a list of (client, cookie, address)
+                    tuples
         """
         clients_size = c_size_t(512)
         cookies_size = c_size_t(512)