From: Kefu Chai <kchai@redhat.com>
Date: Fri, 8 Feb 2019 06:27:35 +0000 (+0800)
Subject: mgr/orchestrator: reformat the docstring
X-Git-Tag: v14.1.0~178^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=dec885c651a1ecc60085c3d7b4844efa69c936ea;p=ceph.git

mgr/orchestrator: reformat the docstring

we need to add an empty line before the param and return lines.

so it renders better with sphinx's `automethod::` directive.

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

diff --git a/src/pybind/mgr/orchestrator.py b/src/pybind/mgr/orchestrator.py
index 296bcdaab33c..0ace09d714e3 100644
--- a/src/pybind/mgr/orchestrator.py
+++ b/src/pybind/mgr/orchestrator.py
@@ -191,6 +191,7 @@ class Orchestrator(object):
         # type: (str) -> WriteCompletion
         """
         Add a host to the orchestrator inventory.
+
         :param host: hostname
         """
         raise NotImplementedError()
@@ -199,6 +200,7 @@ class Orchestrator(object):
         # type: (str) -> WriteCompletion
         """
         Remove a host from the orchestrator inventory.
+
         :param host: hostname
         """
         raise NotImplementedError()
@@ -209,6 +211,7 @@ class Orchestrator(object):
         Report the hosts in the cluster.
 
         The default implementation is extra slow.
+
         :return: list of InventoryNodes
         """
         return self.get_inventory()
@@ -233,7 +236,7 @@ class Orchestrator(object):
         When viewing a CephFS filesystem in the dashboard, we would use this
         to display the pods being currently run for MDS daemons.
 
-        Returns a list of ServiceDescription objects.
+        :return: list of ServiceDescription objects.
         """
         raise NotImplementedError()
 
@@ -754,9 +757,10 @@ class InventoryDevice(object):
 
         :param only_header: Print only the name of the device attributes
 
-        Ex:
-        >  Device Path           Type       Size    Rotates  Available Model
-        >     /dev/sdc            hdd   50.00 GB       True       True ATA/QEMU
+        Ex::
+
+            Device Path           Type       Size    Rotates  Available Model
+            /dev/sdc            hdd   50.00 GB       True       True ATA/QEMU
 
         """
         row_format = "  {0:<15} {1:>10} {2:>10} {3:>10} {4:>10} {5:<15}\n"