From ba3ccee01b31ef9e39a5016a0ffda18628ec3bc2 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Sun, 6 Mar 2022 15:04:21 +0800 Subject: [PATCH] mgr/cephadm: document notes using "note::" directive so it can be rendered by sphinx in a better way. Signed-off-by: Kefu Chai --- src/pybind/mgr/orchestrator/_interface.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) 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() -- 2.39.5