]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
pybind/mgr: Fix missing empty lines in mgr_module.py
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:31 +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 622ec4e9b2a946d66056db89316b805b6f75789d..e8896685f4f7c3649a736779f80b38c92ac084ae 100644 (file)
@@ -1996,7 +1996,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