]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
pybind/mgr: Fix missing empty lines in mgr_module.py 64266/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Fri, 11 Apr 2025 14:54:28 +0000 (21:54 +0700)
committerZac Dover <zac.dover@proton.me>
Mon, 30 Jun 2025 12:06:26 +0000 (22:06 +1000)
The inline function documentation needs an empty
line between description and metadata.
Otherwise automethod from docs renders the metadata
as text together with the description instead of
rendering it as function metadata, e.g. parameters
and return value.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
(cherry picked from commit b521e969b94b93b41a37ef5f9726ed63cb77a97c)

src/pybind/mgr/mgr_module.py

index c8a93fbcc6de4c6ba4109bdaa8a21ec7f62d0510..38bf2a2442c46f3767b531dee0f4db6946beb12e 100644 (file)
@@ -2070,7 +2070,8 @@ class MgrModule(ceph_module.BaseMgrModule, MgrModuleLoggingMixin):
     @API.expose
     def set_localized_module_option(self, key: str, val: Optional[str]) -> None:
         """
-        Set localized configuration for this ceph-mgr instance
+        Set localized configuration for this ceph-mgr instance.
+
         :param str key:
         :param str val:
         :return: str