Skip to content

Commit

Permalink
Fix docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
lkubb committed Aug 8, 2024
1 parent 3e95838 commit 3dd79ad
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
4 changes: 0 additions & 4 deletions src/saltext/mysql/cache/mysql_cache.py
Original file line number Diff line number Diff line change
Expand Up @@ -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``:
Expand All @@ -47,8 +45,6 @@
.. _`MySQL documentation`: https://github.com/coreos/mysql
.. _`python-mysql documentation`: http://python-mysql.readthedocs.io/en/latest/
"""

import copy
Expand Down
7 changes: 7 additions & 0 deletions src/saltext/mysql/modules/mysql.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3dd79ad

Please sign in to comment.