diff options
| author | Sandra McCann <samccann@redhat.com> | 2020-06-11 22:28:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-11 22:28:24 +0200 |
| commit | 524257a7b0f706d8c362ab42c215d33fd43a4844 (patch) | |
| tree | 98211c8c221d7cbf60d7c163f14e5009a0d9977f | |
| parent | Fix Include_vars example (#69966) (diff) | |
| download | ansible-524257a7b0f706d8c362ab42c215d33fd43a4844.tar.xz ansible-524257a7b0f706d8c362ab42c215d33fd43a4844.zip | |
Document the ability to deprecate by date (#69833)
* Document the ability to deprecate by date
* deprecated_in and deprecated_by_date are mutually exclusive
| -rw-r--r-- | docs/docsite/rst/dev_guide/module_lifecycle.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/docsite/rst/dev_guide/module_lifecycle.rst b/docs/docsite/rst/dev_guide/module_lifecycle.rst index 785466c427..461ee59e79 100644 --- a/docs/docsite/rst/dev_guide/module_lifecycle.rst +++ b/docs/docsite/rst/dev_guide/module_lifecycle.rst @@ -27,7 +27,8 @@ To deprecate a module, you must: 3. Reference the deprecation in the relevant ``porting_guide_x.y.rst``. 4. Add ``deprecated:`` to the documentation with the following sub-values: - :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. + :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:. + :remove_by_date: (Added in Ansible 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:. :why: Optional string that used to detail why this has been removed. :alternative: Inform users they should do instead, i.e. ``Use M(whatmoduletouseinstead) instead.``. |