Skip to content

Commit 87ed19e

Browse files
authored
Update help files for {Get-Installed, Install, Publish, Save, and Uninstall}-PSResource (#435)
1 parent 91e32d4 commit 87ed19e

File tree

5 files changed

+168
-266
lines changed

5 files changed

+168
-266
lines changed

help/Get-InstalledPSResource.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Get-InstalledPSResource [[-Name] <String[]>] [-Version <String>] [-Path <String>
1717
```
1818

1919
## DESCRIPTION
20-
The Get-InstalledPSResource cmdlet combines the Get-InstalledModule, Get-InstalledScript cmdlets from V2. It performs a search within module or script installation paths based on the -Name parameter argument. It returns PSResourceInfo objects which describe each resource item found. Other parameters allow the returned results to be filtered by version and path.
20+
The Get-InstalledPSResource cmdlet combines the Get-InstalledModule, Get-InstalledScript cmdlets from V2. It performs a search within module or script installation paths based on the -Name parameter argument. It returns PSResourceInfo objects which describes each resource item found. Other parameters allow the returned results to be filtered by version and path.
2121

2222
## EXAMPLES
2323

@@ -49,14 +49,21 @@ PS C:\> Get-InstalledPSResource Az -Path .
4949

5050
This will return all versions of the Az module that have been installed in the current directory.
5151

52+
### Example 5
53+
```powershell
54+
PS C:\> Get-InstalledPSResource
55+
```
56+
57+
This will return all versions and scripts installed on the machine.
58+
5259
## PARAMETERS
5360

5461
### -Name
55-
Name of a resource or resources to find. Accepts wild card characters.
62+
Name of a resource or resources to find. Accepts wild card characters or a null value.
5663

5764
```yaml
5865
Type: System.String[]
59-
Parameter Sets: (All)
66+
Parameter Sets: NameParameterSet
6067
Aliases:
6168

6269
Required: False
@@ -71,7 +78,7 @@ Specifies the path to search in.
7178
7279
```yaml
7380
Type: System.String
74-
Parameter Sets: (All)
81+
Parameter Sets: NameParameterSet
7582
Aliases:
7683

7784
Required: False
@@ -82,11 +89,13 @@ Accept wildcard characters: False
8289
```
8390
8491
### -Version
85-
Specifies the version of the resource to be returned. Can be an exact version or a version range.
92+
Specifies the version of the resource to be returned.
93+
Can be an exact version or a version range, using the NuGet versioning syntax.
94+
Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges
8695
8796
```yaml
8897
Type: System.String
89-
Parameter Sets: (All)
98+
Parameter Sets: NameParameterSet
9099
Aliases:
91100

92101
Required: False
@@ -103,7 +112,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
103112
104113
### Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo
105114
```
106-
PSRepositoryItemInfo : {
115+
PSResourceInfo : {
107116
AdditionalMetadata
108117
Author
109118
CompanyName
@@ -119,6 +128,7 @@ PSRepositoryItemInfo : {
119128
Name
120129
PackageManagementProvider
121130
PowerShellGetFormatVersion
131+
PrereleaseLabel
122132
ProjectUri
123133
PublishedDate
124134
ReleaseNotes

0 commit comments

Comments
 (0)