Update cmdlet

Docs/UpdatePSResource.md

@@ -9,16 +9,11 @@ Other parameters allow the returned results to be further filtered.
 
 ### NameParameterSet (Default)
 ``` PowerShell
-[[-Name] <string[]>] [-Version <string>] [-Prerelease] [-Scope <string>]
+[[-Name] <string[]>] [-Version <string>] [-Prerelease] [-Scope <Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType>]
 [-Repository <string[]>] [-TrustRepository] [-Credential <pscredential>] [-Quiet] 
 [-AcceptLicense] [-NoClobber] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
-### InputObjectParameterSet
-``` PowerShell
-[[-InputObject] <object[]> [-WhatIf] [-Confirm] [<CommonParameters>]
-```
-
 ## Parameters
 
 ### -Name
@@ -74,8 +69,8 @@ Parameter Sets: NameParameterSet
 Specifies the scope of the resource to update.
 
 ```yml
-Type: string
-Parameter Sets: NameParameterSet, RequiredResourceFileParameterSet 
+Type: Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType
+Parameter Sets: NameParameterSet
 AllowedValues: 'CurrentUser','AllUsers'
 ```
 
@@ -85,7 +80,7 @@ Suppresses being prompted for untrusted sources.
 
 ```yml
 Type: SwitchParameter
-Parameter Sets: NameParameterSet, RequiredResourceFileParameterSet  
+Parameter Sets: NameParameterSet
 ```
 
 ### -Credential
@@ -115,30 +110,19 @@ Type: SwitchParameter
 Parameter Sets: (All)
 ```
 
-### -NoClobber
-
-Prevents updating modules that have the same cmdlets as a differently named module already
-
-```yml
-Type: SwitchParameter
-Parameter Sets: NameParameterSet
-```
-
-
 ### Outputs
 
 No output.
 
 ## Notes
-Input object still needs to be implemented.
 
 Should a -PassThru parameter be added?
 
 ## Tests
 
 Most update tests can be performed on a local repository.  
 
-Some tests should be performed on remote repository (PSGallery) to verify remote operation, but can be limited.  
+Some tests should be performed on remote repository (PoshTestGallery) to verify remote operation, but can be limited.  
 
 ### -Name param
 
@@ -149,11 +133,6 @@ Some tests should be performed on remote repository (PSGallery) to verify remote
 - Errors: Not found (single name, wildcard, multiple name)
 - Errors: Repository: Invalid name, connection error, etc
 
-### -Type InputObject
-
-- Validate pipeline input
-- Errors: The object passed in is not the correct type
-
 ### -Version param
 
 - Validate the resource is updated to the correct version 
@@ -193,11 +172,6 @@ Some tests should be performed on remote repository (PSGallery) to verify remote
 
 - Validate that modules which require license agreements are approved without a prompt
 
-### -NoClobber
-
-- Validate that resources are not overwritten when flag is passed
-
-
 ## Work Items
 
 ### Create cmdlet and parameter sets

help/Update-PSResource.md

@@ -8,39 +8,45 @@ schema: 2.0.0
 # Update-PSResource
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Updates a package already installed on the user's machine.
 
 ## SYNTAX
 
 ### NameParameterSet (Default)
 ```
 Update-PSResource [-Name] <String[]> [-Version <String>] [-Prerelease] [-Repository <String[]>]
- [-Scope <String>] [-TrustRepository] [-Credential <PSCredential>] [-Quiet] [-AcceptLicense] [-NoClobber]
- [-WhatIf] [-Confirm] [<CommonParameters>]
-```
-
-### RequiredResourceFileParameterSet
-```
-Update-PSResource [-Scope <String>] [-TrustRepository] [-Quiet] [-AcceptLicense] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+ [-Scope <Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType>] [-TrustRepository] [-Credential <PSCredential>] [-Quiet] [-AcceptLicense] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+The Update-PSResource cmdlet replaces the Update-Module and Update-Script cmdlets from V2.
+It updates an already installed package based on the -Name parameter argument.
+It does not return an object. Other parameters allow the package to be updated to be further filtered.
 
 ## EXAMPLES
 
 ### Example 1
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> Get-InstalledPSResource -Name "TestModule"
+        Name                                    Version                         Prerelease   Description
+        ----                                    -------                         ----------   -----------
+        TestModule                              1.2.0                                        test
+
+        Update-PSResource -Name "TestModule"
+        Get-InstalledPSResource -Name "TestModule"
+        Name                                    Version                         Prerelease   Description
+        ----                                    -------                         ----------   -----------
+        TestModule                              1.3.0                                        test
+        TestModule                              1.2.0                                        test
+
 ```
 
-{{ Add example description here }}
+In this example, the user already has the TestModule package installed and they update the package. Update-PSResource will install the latest version of the package without deleting the older version installed.
 
 ## PARAMETERS
 
 ### -AcceptLicense
-{{ Fill AcceptLicense Description }}
+For resources that require a license, AcceptLicense automatically accepts the license agreement during the update.
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -55,7 +61,7 @@ Accept wildcard characters: False
 ```
 
 ### -Credential
-{{ Fill Credential Description }}
+Specifies optional credentials to be used when accessing a private repository.
 
 ```yaml
 Type: System.Management.Automation.PSCredential
@@ -65,12 +71,12 @@ Aliases:
 Required: False
 Position: Named
 Default value: None
-Accept pipeline input: True (ByPropertyName)
+Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -Name
-{{ Fill Name Description }}
+Specifies name of a resource or resources to update.
 
 ```yaml
 Type: System.String[]
@@ -79,28 +85,13 @@ Aliases:
 
 Required: True
 Position: 0
-Default value: None
+Default value: "*"
 Accept pipeline input: True (ByPropertyName, ByValue)
-Accept wildcard characters: False
-```
-
-### -NoClobber
-{{ Fill NoClobber Description }}
-
-```yaml
-Type: System.Management.Automation.SwitchParameter
-Parameter Sets: NameParameterSet
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
+Accept wildcard characters: True
 ```
 
 ### -Prerelease
-{{ Fill Prerelease Description }}
+When specified, allows updating to a prerelease version.
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -115,7 +106,7 @@ Accept wildcard characters: False
 ```
 
 ### -Quiet
-{{ Fill Quiet Description }}
+Supresses progress information.
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -130,7 +121,8 @@ Accept wildcard characters: False
 ```
 
 ### -Repository
-{{ Fill Repository Description }}
+Specifies one or more repository names to update packages from.
+If not specified, search for packages to update will include all currently registered repositories in order of highest priority.
 
 ```yaml
 Type: System.String[]
@@ -145,10 +137,10 @@ Accept wildcard characters: False
 ```
 
 ### -Scope
-{{ Fill Scope Description }}
+Specifies the scope of the resource to update.
 
 ```yaml
-Type: System.String
+Type: Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType
 Parameter Sets: (All)
 Aliases:
 Accepted values: CurrentUser, AllUsers
@@ -161,7 +153,7 @@ Accept wildcard characters: False
 ```
 
 ### -TrustRepository
-{{ Fill TrustRepository Description }}
+Specifies optional credentials to be used when accessing a private repository.
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -176,7 +168,7 @@ Accept wildcard characters: False
 ```
 
 ### -Version
-{{ Fill Version Description }}
+Specifies the version the resource is to be updated to.
 
 ```yaml
 Type: System.String
@@ -228,15 +220,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ### System.String[]
 
-### System.Management.Automation.PSCredential
-
 ## OUTPUTS
 
-### System.Object
-
 ## NOTES
 
 ## RELATED LINKS
 
 [<add>](<add>)
-

src/PowerShellGet.psd1

@@ -20,8 +20,8 @@
         'Set-PSResourceRepository',
         'Publish-PSResource',
         'Uninstall-PSResource',
-        'Unregister-PSResourceRepository')
-        # 'Update-PSResource')
+        'Unregister-PSResourceRepository',
+        'Update-PSResource')
 
     VariablesToExport = 'PSGetPath'
     AliasesToExport = @('inmo', 'fimo', 'upmo', 'pumo')