From 4e7e6d8b3d9680d8328c4750dc924d2a62701da7 Mon Sep 17 00:00:00 2001 From: Twangboy Date: Mon, 29 May 2023 11:56:39 -0600 Subject: [PATCH] Fix docs for appx.absent state module --- salt/modules/win_appx.py | 4 ++-- salt/states/win_appx.py | 15 ++++++++------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/salt/modules/win_appx.py b/salt/modules/win_appx.py index 6193872a33f..8a6a22549f6 100644 --- a/salt/modules/win_appx.py +++ b/salt/modules/win_appx.py @@ -13,7 +13,7 @@ they be upgraded. An app removed with this module can only be re-provisioned on the machine, but it can't be re-installed for all users. Also, once a package has been deprovisioned, the only way to reinstall it is to download the package. This is -difficult. I've outlined the steps below: +difficult. The steps are outlined below: 1. Obtain the Microsoft Store URL for the app: - Open the page for the app in the Microsoft Store @@ -25,7 +25,7 @@ difficult. I've outlined the steps below: - Ensure Retail is selected in the 2nd dropdown - Click the checkmark button -This should give you a list of URLs for the package and all dependencies for all +This should return a list of URLs for the package and all dependencies for all architectures. Download the package and all dependencies for your system architecture. These will usually have one of the following file extensions: diff --git a/salt/states/win_appx.py b/salt/states/win_appx.py index dc1bc58db1f..75d90224b51 100644 --- a/salt/states/win_appx.py +++ b/salt/states/win_appx.py @@ -43,12 +43,13 @@ def absent(name, query, include_store=False, frameworks=False, deprovision_only= string matches multiple packages, they will all be removed. Here are some example strings: - - ``*teams*`` - Remove Microsoft Teams - - ``*zune*`` - Remove Windows Media Player and ZuneVideo - - ``*zuneMusic*`` - Only remove Windows Media Player - - ``*xbox*`` - Remove all xbox packages, there are 5 by default - - ``*`` - Remove everything but the Microsoft Store, unless - ``include_store=True`` + | string | description | + | --------------- | ----------- | + | ``*teams*`` | Remove Microsoft Teams | + | ``*zune*`` | Remove Windows Media Player and Zune Video | + | ``*zuneMusic*`` | Only remove Windows Media Player | + | ``*xbox*`` | Remove all xBox packages, there are 5 by default + | ``*`` | Remove everything but the Microsoft Store, unless ``include_store=True`` | .. note:: Use the ``appx.list`` function to make sure your query is @@ -85,7 +86,7 @@ def absent(name, query, include_store=False, frameworks=False, deprovision_only= remove_candy_crush: appx.absent: - query: *candy* + - query: "*candy*" """ ret = {"name": name, "result": True, "comment": "", "changes": {}}