From 3b99ed42648661716762a6032a51ab2799284ad8 Mon Sep 17 00:00:00 2001 From: Anam Navied Date: Thu, 5 Aug 2021 11:27:29 -0400 Subject: [PATCH 1/7] update help files with note about minimum inclusive version not being supported according to NuGet version documentation --- help/Find-PSResource.md | 12 ++++++++++-- help/Get-InstalledPSResource.md | 13 ++++++++++--- help/Install-PSResource.md | 13 ++++++++++--- help/Save-PSResource.md | 13 ++++++++++--- help/Update-PSResource.md | 11 +++++++++-- 5 files changed, 49 insertions(+), 13 deletions(-) diff --git a/help/Find-PSResource.md b/help/Find-PSResource.md index 9c0f8b892..5135eaa58 100644 --- a/help/Find-PSResource.md +++ b/help/Find-PSResource.md @@ -207,8 +207,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be returned. -Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges +Specifies the version of the resource to be found. +Can be an exact version or a version range, using the NuGet versioning syntax. + +Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. + +All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are +supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. +So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) +but instead will consider that as the required version and yield version 1.0.0.0 only (required version). +To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. ```yaml Type: System.String diff --git a/help/Get-InstalledPSResource.md b/help/Get-InstalledPSResource.md index d5b320ab1..cfd573b20 100644 --- a/help/Get-InstalledPSResource.md +++ b/help/Get-InstalledPSResource.md @@ -89,9 +89,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be returned. -Can be an exact version or a version range, using the NuGet versioning syntax. -Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges +Specifies the version of the resource to be returned. +Can be an exact version or a version range, using the NuGet versioning syntax. + +Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. + +All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are +supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. +So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) +but instead will consider that as the required version and yield version 1.0.0.0 only (required version). +To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. ```yaml Type: System.String diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index 47765a5f2..b7d695db2 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -72,9 +72,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be installed. -Can be an exact version or a version range, using the NuGet versioning syntax. -Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges +Specifies the version of the resource to be installed. +Can be an exact version or a version range, using the NuGet versioning syntax. + +Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. + +All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are +supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. +So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) +but instead will consider that as the required version and yield version 1.0.0.0 only (required version). +To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. ```yaml Type: System.String diff --git a/help/Save-PSResource.md b/help/Save-PSResource.md index ca6ae0889..93b96a64b 100644 --- a/help/Save-PSResource.md +++ b/help/Save-PSResource.md @@ -66,9 +66,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be saved. -Can be an exact version or a version range, using the NuGet versioning syntax. -Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges +Specifies the version of the resource to be saved. +Can be an exact version or a version range, using the NuGet versioning syntax. + +Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. + +All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are +supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. +So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) +but instead will consider that as the required version and yield version 1.0.0.0 only (required version). +To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. ```yaml Type: System.String diff --git a/help/Update-PSResource.md b/help/Update-PSResource.md index 8ee64d319..8a2b84635 100644 --- a/help/Update-PSResource.md +++ b/help/Update-PSResource.md @@ -169,8 +169,15 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version the resource is to be updated to. -Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges +Specifies the version of the resource to be updated to. +Can be an exact version or a version range, using the NuGet versioning syntax. + +Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. + +All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are +supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. +So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) +but instead will consider that as the required version and yield version 1.0.0.0 only (required version). To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. ```yaml Type: System.String From 4f23219614b8897e086f3875c083f579e8862a4a Mon Sep 17 00:00:00 2001 From: Anam Navied Date: Thu, 5 Aug 2021 16:10:05 -0400 Subject: [PATCH 2/7] Update help/Get-InstalledPSResource.md Co-authored-by: Sean Wheeler --- help/Get-InstalledPSResource.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/help/Get-InstalledPSResource.md b/help/Get-InstalledPSResource.md index cfd573b20..0b1d784bd 100644 --- a/help/Get-InstalledPSResource.md +++ b/help/Get-InstalledPSResource.md @@ -89,16 +89,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be returned. -Can be an exact version or a version range, using the NuGet versioning syntax. +Specifies the version of the resource to be returned. The value can be an exact version or a version +range using the NuGet versioning syntax. -Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. +For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges) -All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are -supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. -So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) -but instead will consider that as the required version and yield version 1.0.0.0 only (required version). -To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. +PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range +documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher +(minimum inclusive range). Instead, the values is considered as the required version and yields +version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as +the version range. ```yaml Type: System.String From 24deefccfdbd75512144f42834e80dcf793a9562 Mon Sep 17 00:00:00 2001 From: Anam Navied Date: Thu, 5 Aug 2021 16:10:47 -0400 Subject: [PATCH 3/7] Update help/Save-PSResource.md Co-authored-by: Sean Wheeler --- help/Save-PSResource.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/help/Save-PSResource.md b/help/Save-PSResource.md index 93b96a64b..dd262b1ee 100644 --- a/help/Save-PSResource.md +++ b/help/Save-PSResource.md @@ -66,16 +66,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be saved. -Can be an exact version or a version range, using the NuGet versioning syntax. +Specifies the version of the resource to be returned. The value can be an exact version or a version +range using the NuGet versioning syntax. -Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. +For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges) -All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are -supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. -So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) -but instead will consider that as the required version and yield version 1.0.0.0 only (required version). -To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. +PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range +documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher +(minimum inclusive range). Instead, the values is considered as the required version and yields +version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as +the version range. ```yaml Type: System.String From 7aeecd134e362c50b509d3028609b00fa19cb0a5 Mon Sep 17 00:00:00 2001 From: Anam Navied Date: Thu, 5 Aug 2021 16:10:56 -0400 Subject: [PATCH 4/7] Update help/Update-PSResource.md Co-authored-by: Sean Wheeler --- help/Update-PSResource.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/help/Update-PSResource.md b/help/Update-PSResource.md index 8a2b84635..0f4a9129c 100644 --- a/help/Update-PSResource.md +++ b/help/Update-PSResource.md @@ -169,15 +169,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be updated to. -Can be an exact version or a version range, using the NuGet versioning syntax. +Specifies the version of the resource to be returned. The value can be an exact version or a version +range using the NuGet versioning syntax. -Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. +For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges) -All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are -supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. -So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) -but instead will consider that as the required version and yield version 1.0.0.0 only (required version). To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. +PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range +documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher +(minimum inclusive range). Instead, the values is considered as the required version and yields +version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as +the version range. ```yaml Type: System.String From 837f1b24d1dac7ed1d86567cd906e826c0dcf638 Mon Sep 17 00:00:00 2001 From: Anam Navied Date: Thu, 5 Aug 2021 16:13:46 -0400 Subject: [PATCH 5/7] update help doc for Find and Install per Sean suggestions --- help/Find-PSResource.md | 16 ++++++++-------- help/Install-PSResource.md | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/help/Find-PSResource.md b/help/Find-PSResource.md index 5135eaa58..cac8dfa5b 100644 --- a/help/Find-PSResource.md +++ b/help/Find-PSResource.md @@ -207,16 +207,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be found. -Can be an exact version or a version range, using the NuGet versioning syntax. +Specifies the version of the resource to be returned. The value can be an exact version or a version +range using the NuGet versioning syntax. -Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. +For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges) -All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are -supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. -So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) -but instead will consider that as the required version and yield version 1.0.0.0 only (required version). -To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. +PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range +documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher +(minimum inclusive range). Instead, the values is considered as the required version and yields +version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as +the version range. ```yaml Type: System.String diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index b7d695db2..647f22df8 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -72,16 +72,16 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be installed. -Can be an exact version or a version range, using the NuGet versioning syntax. +Specifies the version of the resource to be returned. The value can be an exact version or a version +range using the NuGet versioning syntax. -Expected NuGet Version/Version Range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. +For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges) -All but the "minimum inclusive version" listed in the NuGet Version/Version Range documentation above are -supported. The NuGet version documentation suggested minimum inclusive version will be considered as a required version instead in PowerShellGet. -So inputting "1.0.0.0" as the version won't yield versions 1.0.0.0 and higher (minimum inclusive range) -but instead will consider that as the required version and yield version 1.0.0.0 only (required version). -To use the minimum inclusive range, provide "[1.0.0.0, ]" as the version range. +PowerShellGet supports all but the _minimum inclusive version_ listed in the NuGet version range +documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher +(minimum inclusive range). Instead, the values is considered as the required version and yields +version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as +the version range. ```yaml Type: System.String From ae686f9f565066a44298d121adf70fd834b41120 Mon Sep 17 00:00:00 2001 From: Anam Navied Date: Thu, 5 Aug 2021 16:17:41 -0400 Subject: [PATCH 6/7] fix typo --- help/Install-PSResource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index 647f22df8..ddecc1257 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -72,7 +72,7 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be returned. The value can be an exact version or a version +Specifies the version of the resource to be installed. The value can be an exact version or a version range using the NuGet versioning syntax. For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges) From 74aeced17654c583c707240f1917423b5ee73031 Mon Sep 17 00:00:00 2001 From: Anam Navied Date: Thu, 5 Aug 2021 16:25:51 -0400 Subject: [PATCH 7/7] update help docs for Save and Update with typo --- help/Save-PSResource.md | 2 +- help/Update-PSResource.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/help/Save-PSResource.md b/help/Save-PSResource.md index dd262b1ee..44d7f90a5 100644 --- a/help/Save-PSResource.md +++ b/help/Save-PSResource.md @@ -66,7 +66,7 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be returned. The value can be an exact version or a version +Specifies the version of the resource to be saved. The value can be an exact version or a version range using the NuGet versioning syntax. For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges) diff --git a/help/Update-PSResource.md b/help/Update-PSResource.md index 0f4a9129c..238abfb6e 100644 --- a/help/Update-PSResource.md +++ b/help/Update-PSResource.md @@ -169,7 +169,7 @@ Accept wildcard characters: False ``` ### -Version -Specifies the version of the resource to be returned. The value can be an exact version or a version +Specifies the version of the resource to be updated to. The value can be an exact version or a version range using the NuGet versioning syntax. For more information about NuGet version ranges, see [Package versioning](/nuget/concepts/package-versioning#version-ranges)