Fix docs for appx.absent state module

This commit is contained in:
Twangboy 2023-05-29 11:56:39 -06:00 committed by Megan Wilhite
parent 6ce69654c7
commit 4e7e6d8b3d
2 changed files with 10 additions and 9 deletions

View file

@ -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:

View file

@ -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": {}}