From: Kefu Chai <kchai@redhat.com>
Date: Wed, 15 Feb 2017 06:12:29 +0000 (+0800)
Subject: pybind: cephfs: add docstring for LibCephFS's __init__()
X-Git-Tag: v12.0.1~389^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=4b19aa513f590494cd8fc7d3c0fd6add68e6e2d9;p=ceph.git

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

Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/src/pybind/cephfs/cephfs.pyx b/src/pybind/cephfs/cephfs.pyx
index 8d33033ae734..b7b406cd95e3 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: