From: Kefu Chai Date: Sun, 6 Mar 2022 07:04:21 +0000 (+0800) Subject: mgr/cephadm: document notes using "note::" directive X-Git-Tag: v18.0.0~1277^2~2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=ba3ccee01b31ef9e39a5016a0ffda18628ec3bc2;p=ceph.git mgr/cephadm: document notes using "note::" directive so it can be rendered by sphinx in a better way. Signed-off-by: Kefu Chai --- diff --git a/src/pybind/mgr/orchestrator/_interface.py b/src/pybind/mgr/orchestrator/_interface.py index 2de2b2af08770..6183674a87fd1 100644 --- a/src/pybind/mgr/orchestrator/_interface.py +++ b/src/pybind/mgr/orchestrator/_interface.py @@ -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()