Skip to content

Commit dcf892e

Browse files
authored
Update help documentation for minimum inclusive version range (#442)
* update help files with note about minimum inclusive version not being supported according to NuGet version documentation
1 parent 1bf47ed commit dcf892e

File tree

5 files changed

+50
-13
lines changed

5 files changed

+50
-13
lines changed

help/Find-PSResource.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,16 @@ Accept wildcard characters: False
207207
```
208208
209209
### -Version
210-
Specifies the version of the resource to be returned.
211-
Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges
210+
Specifies the version of the resource to be returned. The value can be an exact version or a version
211+
range using the NuGet versioning syntax.
212+
213+
For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges)
214+
215+
PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range
216+
documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher
217+
(minimum inclusive range). Instead, the values is considered as the required version and yields
218+
version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as
219+
the version range.
212220

213221
```yaml
214222
Type: System.String

help/Get-InstalledPSResource.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,16 @@ Accept wildcard characters: False
8989
```
9090
9191
### -Version
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
92+
Specifies the version of the resource to be returned. The value can be an exact version or a version
93+
range using the NuGet versioning syntax.
94+
95+
For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges)
96+
97+
PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range
98+
documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher
99+
(minimum inclusive range). Instead, the values is considered as the required version and yields
100+
version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as
101+
the version range.
95102

96103
```yaml
97104
Type: System.String

help/Install-PSResource.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,16 @@ Accept wildcard characters: False
7272
```
7373
7474
### -Version
75-
Specifies the version of the resource to be installed.
76-
Can be an exact version or a version range, using the NuGet versioning syntax.
77-
Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges
75+
Specifies the version of the resource to be installed. The value can be an exact version or a version
76+
range using the NuGet versioning syntax.
77+
78+
For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges)
79+
80+
PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range
81+
documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher
82+
(minimum inclusive range). Instead, the values is considered as the required version and yields
83+
version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as
84+
the version range.
7885

7986
```yaml
8087
Type: System.String

help/Save-PSResource.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,16 @@ Accept wildcard characters: False
6666
```
6767
6868
### -Version
69-
Specifies the version of the resource to be saved.
70-
Can be an exact version or a version range, using the NuGet versioning syntax.
71-
Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges
69+
Specifies the version of the resource to be saved. The value can be an exact version or a version
70+
range using the NuGet versioning syntax.
71+
72+
For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges)
73+
74+
PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range
75+
documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher
76+
(minimum inclusive range). Instead, the values is considered as the required version and yields
77+
version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as
78+
the version range.
7279

7380
```yaml
7481
Type: System.String

help/Update-PSResource.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,16 @@ Accept wildcard characters: False
169169
```
170170
171171
### -Version
172-
Specifies the version the resource is to be updated to.
173-
Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges
172+
Specifies the version of the resource to be updated to. The value can be an exact version or a version
173+
range using the NuGet versioning syntax.
174+
175+
For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges)
176+
177+
PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range
178+
documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher
179+
(minimum inclusive range). Instead, the values is considered as the required version and yields
180+
version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as
181+
the version range.
174182

175183
```yaml
176184
Type: System.String

0 commit comments

Comments
 (0)