From ae4fa4e3f50c1bc9c9dc49f8b7eccfcc029a7ccc Mon Sep 17 00:00:00 2001 From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Fri, 11 Apr 2025 21:54:28 +0700 Subject: [PATCH] pybind/mgr: Fix missing empty lines in mgr_module.py 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 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/pybind/mgr/mgr_module.py b/src/pybind/mgr/mgr_module.py index 622ec4e9b2a..e8896685f4f 100644 --- a/src/pybind/mgr/mgr_module.py +++ b/src/pybind/mgr/mgr_module.py @@ -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 -- 2.39.5