You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docsite/rst/dev_guide/module_lifecycle.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ To deprecate a module in ansible-core, you must:
32
32
:removed_in: A ``string``, such as ``"2.10"``; the version of Ansible where the module will be replaced with a docs-only module stub. Usually current release +4. Mutually exclusive with :removed_by_date:.
33
33
:remove_by_date: (Added in ansible-base 2.10). An ISO 8601 formatted date when the module will be removed. Usually 2 years from the date the module is deprecated. Mutually exclusive with :removed_in:.
34
34
:why: Optional string that used to detail why this has been removed.
35
-
:alternative: Inform users they should do instead, for example, ``Use M(whatmoduletouseinstead) instead.``.
35
+
:alternatives: Inform users they should do instead, for example, ``Use M(whatmoduletouseinstead) instead.``.
36
36
37
37
* For an example of documenting deprecation, see this `PR that deprecates multiple modules <https://github.com/ansible/ansible/pull/43781/files>`_.
38
38
Some of the elements in the PR might now be out of date.
0 commit comments