]> 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)
committerLaura Flores <lflores@redhat.com>
Mon, 25 Apr 2022 17:43:45 +0000 (12:43 -0500)
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 3cf0bee070b114eec60d3d3b1f33753d80a60dbc..4248205f0a4724648921cfbe1869ef5fe0dc57ed 100644 (file)
@@ -980,8 +980,9 @@ 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.
 
-        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()