]> git-server-git.apps.pok.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)
committerDavid Galloway <dgallowa@redhat.com>
Tue, 12 Apr 2022 14:03:41 +0000 (10:03 -0400)
so it can be rendered by sphinx in a better way.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
(cherry picked from commit ba3ccee01b31ef9e39a5016a0ffda18628ec3bc2)

src/pybind/mgr/orchestrator/_interface.py

index 1d9b09581f3c02d54f6a87d07cc2cd62d53a8d9d..be18f0f34e2dd961b59ee24eb2bced80149c5ef4 100644 (file)
@@ -566,8 +566,10 @@ class Orchestrator(object):
         :param replace: marks the OSD as being destroyed. See :ref:`orchestrator-osd-replace`
         :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()