]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
mgr/cephadm: add empty line after param list in docstring
authorKefu Chai <tchaikov@gmail.com>
Sun, 6 Mar 2022 06:23:42 +0000 (14:23 +0800)
committerLaura Flores <lflores@redhat.com>
Mon, 25 Apr 2022 17:43:45 +0000 (12:43 -0500)
this helps to silence the warning from sphinx, like

src/pybind/mgr/orchestrator/_interface.py:docstring of orchestrator._interface.Orchestrator.remove_osds:9: WARNING: Field list ends without a blank line; unexpected unindent.

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

 Conflicts:
src/pybind/mgr/orchestrator/_interface.py
- `:param zap:` did not exist in Octopus; removed
   this from the param list.

src/pybind/mgr/orchestrator/_interface.py

index 2780b00cf7421ee6682e4d22755147a191fea2f3..3cf0bee070b114eec60d3d3b1f33753d80a60dbc 100644 (file)
@@ -979,6 +979,7 @@ class Orchestrator(object):
         :param osd_ids: list of OSD IDs
         :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).
         """