saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-16 09:40:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

update documentation to include ignore_list

Browse source
This commit is contained in:
Gareth J. Greenaway 2023-06-29 08:38:05 -07:00 • committed by Megan Wilhite
parent f0933cf408
commit 3e18925289
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/topics/development/salt_extensions.rst
View file

@ -69,10 +69,11 @@ How do I deprecate a Salt module to a Salt extension
To indicate that a Salt module is being deprecated in favor of a Salt extension,
for each Salt module include ``__deprecated__`` tuple in the module. The tuple
should include the version of Salt that the module will be removed, the name of the
collection of modules that are being deprecated, and the URL where the source for
the new extension can be found. The version should be 2 major versions from the
next major release. For example, if the next major release of Salt is 3100, the
deprecation version should be set to 3102.
collection of modules that are being deprecated, the URL where the source for
the new extension can be found, and optionally any functions within the module that
should be ignored when applying the warning. The version should be 2 major versions
from the next major release. For example, if the next major release of Salt is 3100,
the deprecation version should be set to 3102.
.. code-block: python
@ -81,3 +82,10 @@ deprecation version should be set to 3102.
"boto",
"https://github.com/salt-extensions/saltext-boto",
)
__deprecated__ = (
3009,
"boto",
"https://github.com/salt-extensions/saltext-boto",
ignore_list=["get_all_eip_addresses"],
)