From dec885c651a1ecc60085c3d7b4844efa69c936ea Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Fri, 8 Feb 2019 14:27:35 +0800 Subject: [PATCH] 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 --- src/pybind/mgr/orchestrator.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/pybind/mgr/orchestrator.py b/src/pybind/mgr/orchestrator.py index 296bcdaab33c1..0ace09d714e36 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" -- 2.39.5