pybind: cephfs: add docstring for LibCephFS's __init__()

Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit is contained in:
Kefu Chai 2017-02-15 14:12:29 +08:00
parent 72b57b8f25
commit 4b19aa513f

View 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: