updating doc strings (#147)

* updating doc strings
Azure · Mar 5, 2024 · cfd9439 · cfd9439
1 parent c2b5e0c
commit cfd9439
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -1,6 +1,14 @@
 Microsoft Azure Batch Extensions
 ================================
 
+Azure Batch CLI extensions will be retired on 30 September 2024
+https://azure.microsoft.com/updates/azure-batch-cli-extensions-will-be-retired-on-30-september-2024/
+
+Remove the Azure Batch CLI Extensions: 
+.. code-block:: bash
+
+	$ az extension remove -n azure-batch-cli-extensions
+
 .. image:: https://travis-ci.org/Azure/azure-batch-cli-extensions.svg?branch=master
  :target: https://travis-ci.org/Azure/azure-batch-cli-extensions
 

diff --git a/batch-cli-extensions/HISTORY.rst b/batch-cli-extensions/HISTORY.rst
@@ -2,6 +2,10 @@
 
 Release History
 ===============
+7.0.1 (2024-03-01)
+------------------
+
+* Update documentation.
 
 7.0.0 (2022-09-9)
 ------------------

diff --git a/batch-cli-extensions/README.rst b/batch-cli-extensions/README.rst
@@ -1,6 +1,15 @@
 Microsoft Azure Batch CLI Extensions for Windows, Mac and Linux
 ===============================================================
 
+Azure Batch CLI extensions will be retired on 30 September 2024
+https://azure.microsoft.com/updates/azure-batch-cli-extensions-will-be-retired-on-30-september-2024/
+
+Remove the Azure Batch CLI Extensions: 
+.. code-block:: bash
+
+	$ az extension remove -n azure-batch-cli-extensions
+
+
 This project is a preview build of the Microsoft Azure command-line interface to demonstrate proposed features in Azure Batch.
 For further details on the Azure CLI, please check the `official documentation <https://docs.microsoft.com/en-us/cli/azure/install-azure-cli>`_.
 

diff --git a/batch-cli-extensions/azext_batch/azext_metadata.json b/batch-cli-extensions/azext_batch/azext_metadata.json
@@ -1,4 +1,3 @@
 {
-  "azext.minCliCoreVersion": "2.0.74",
-  "azext.maxCliCoreVersion": "3.0.0"
+  "azext.minCliCoreVersion": "2.30.0"
 }
diff --git a/batch-cli-extensions/azext_batch/commands.py b/batch-cli-extensions/azext_batch/commands.py
@@ -17,13 +17,16 @@
 MINIMUM_UNSUPPORTED_BMGMT_VERSION = "16.3"
 MINIMUM_UNSUPPORTED_BATCH_EXT_VERSION = "9.1"
 
-
+def deprecation_warning():
+    logger.warning("Azure Batch CLI extensions will be retired on 30 September 2024\n https://azure.microsoft.com/updates/azure-batch-cli-extensions-will-be-retired-on-30-september-2024/\n")
+
 def confirm_version(current, supported, package):
     if version.StrictVersion(current) >= version.StrictVersion(supported):
         logger.warning("This package of the Batch Extensions module supports "
                        "%s up to version %s. The current version %s has not been "
                        "tested for compatibility.", package, supported, current)
 
+deprecation_warning()
 confirm_version(batch_version, MINIMUM_UNSUPPORTED_BATCH_VERSION, "Azure Batch")
 confirm_version(batch_mgmt_version, MINIMUM_UNSUPPORTED_BMGMT_VERSION, "Azure Batch Management")
 confirm_version(batch_ext_version, MINIMUM_UNSUPPORTED_BATCH_EXT_VERSION, "Azure Batch Extensions")

diff --git a/batch-cli-extensions/azext_batch/version.py b/batch-cli-extensions/azext_batch/version.py
@@ -3,4 +3,4 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
 
-VERSION = "7.0.0"
+VERSION = "7.0.1"