From 3dd79ad7b4f7fec9b09dff92d3fd3dff50e4fde7 Mon Sep 17 00:00:00 2001 From: jeanluc Date: Thu, 8 Aug 2024 18:04:05 +0200 Subject: [PATCH] Fix docs build --- src/saltext/mysql/cache/mysql_cache.py | 4 ---- src/saltext/mysql/modules/mysql.py | 7 +++++++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/saltext/mysql/cache/mysql_cache.py b/src/saltext/mysql/cache/mysql_cache.py index 457f6ea4..1e935ce8 100644 --- a/src/saltext/mysql/cache/mysql_cache.py +++ b/src/saltext/mysql/cache/mysql_cache.py @@ -36,8 +36,6 @@ # This may be enabled to create a fresh connection on every call mysql.fresh_connection: false -Related docs can be found in the `python-mysql documentation`_. - To use the mysql as a minion data cache backend, set the master ``cache`` config value to ``mysql``: @@ -47,8 +45,6 @@ .. _`MySQL documentation`: https://github.com/coreos/mysql -.. _`python-mysql documentation`: http://python-mysql.readthedocs.io/en/latest/ - """ import copy diff --git a/src/saltext/mysql/modules/mysql.py b/src/saltext/mysql/modules/mysql.py index 9767ba93..c5af81ec 100644 --- a/src/saltext/mysql/modules/mysql.py +++ b/src/saltext/mysql/modules/mysql.py @@ -186,6 +186,13 @@ "XA_RECOVER_ADMIN", ] +# The empty docstring is needed to ignore the developer note during +# docs rendering (quick fix). There might be better ways. + +""" +""" + +# pylint: disable=pointless-string-statement r''' DEVELOPER NOTE: ABOUT arguments management, escapes, formats, arguments and security of SQL.