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

Clarify what version numbers to include in the deprecation decorator.

Browse source
This commit is contained in:
Gareth J. Greenaway 2023-06-28 13:03:12 -07:00 • committed by Megan Wilhite
parent 055277d101
commit 25ad522344
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -63,7 +63,9 @@ 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 new extension can be found. The version should be 2 major versions from the
next major release. For example, the next major release of Salt is 3100, the
deprecation version should be set to 3102.
.. code-block: python