From 4b19aa513f590494cd8fc7d3c0fd6add68e6e2d9 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Wed, 15 Feb 2017 14:12:29 +0800 Subject: [PATCH] pybind: cephfs: add docstring for LibCephFS's __init__() Signed-off-by: Kefu Chai --- src/pybind/cephfs/cephfs.pyx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/pybind/cephfs/cephfs.pyx b/src/pybind/cephfs/cephfs.pyx index 8d33033ae73..b7b406cd95e 100644 --- a/src/pybind/cephfs/cephfs.pyx +++ b/src/pybind/cephfs/cephfs.pyx @@ -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: -- 2.39.5