]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
pybind: cephfs: add docstring for LibCephFS's __init__()
authorKefu Chai <kchai@redhat.com>
Wed, 15 Feb 2017 06:12:29 +0000 (14:12 +0800)
committerKefu Chai <kchai@redhat.com>
Wed, 15 Feb 2017 06:50:59 +0000 (14:50 +0800)
Signed-off-by: Kefu Chai <kchai@redhat.com>
src/pybind/cephfs/cephfs.pyx

index 8d33033ae73438d7d08ad31c1c58470c15e1d488..b7b406cd95e32e2c82db3faaf52828785bc3c8c4 100644 (file)
@@ -339,6 +339,13 @@ cdef class LibCephFS(object):
                                   "CephFS object in state %s." % (self.state))
 
     def __cinit__(self, conf=None, conffile=None, auth_id=None, rados_inst=None):
+        """Create a libcephfs wrapper
+
+        :param conf dict opt: settings overriding the default ones and conffile
+        :param conffile str opt: the path to ceph.conf to override the default settings
+        :auth_id str opt: the id used to authenticate the client entity
+        :rados_inst Rados opt: a rados.Rados instance
+        """
         PyEval_InitThreads()
         self.state = "uninitialized"
         if rados_inst is not None: