]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
mgr/cephadm: document notes using "note::" directive
authorKefu Chai <tchaikov@gmail.com>
Sun, 6 Mar 2022 07:04:21 +0000 (15:04 +0800)
committerKefu Chai <tchaikov@gmail.com>
Sun, 6 Mar 2022 07:04:48 +0000 (15:04 +0800)
so it can be rendered by sphinx in a better way.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
src/pybind/mgr/orchestrator/_interface.py

index 2de2b2af08770902c2937ee19434725caa5db96e..6183674a87fd1c7a5bd0def083a62d0000979802 100644 (file)
@@ -566,8 +566,9 @@ class Orchestrator(object):
         :param force: Forces the OSD removal process without waiting for the data to be drained first.
         :param zap: Zap/Erase all devices associated with the OSDs (DESTROYS DATA)
 
-        Note that this can only remove OSDs that were successfully
-        created (i.e. got an OSD ID).
+
+        .. note:: this can only remove OSDs that were successfully
+            created (i.e. got an OSD ID).
         """
         raise NotImplementedError()