update online help

Modules/Ruleset.Compatibility/Help/en-US/Add-WinFunction.md

@@ -13,7 +13,7 @@ This command defines a global function that always runs in the compatibility ses
 
 ## SYNTAX
 
-```none
+```powershell
 Add-WinFunction [-Name] <String> [-ScriptBlock] <ScriptBlock> [-ComputerName <String>]
  [-ConfigurationName <String>] [-Credential <PSCredential>] [<CommonParameters>]
 ```
@@ -22,7 +22,7 @@ Add-WinFunction [-Name] <String> [-ScriptBlock] <ScriptBlock> [-ComputerName <St
 
 This command defines a global function that always runs in the compatibility session,
 returning serialized data to the calling session.
-Parameters can be specified using the 'param' statement but only positional parameters are supported.
+Parameters can be specified using the "param" statement but only positional parameters are supported.
 
 By default, when executing, the current compatibility session is used,
 or, in the case where there is no existing session, a new default session will be created.
@@ -34,22 +34,20 @@ This behavior can be overridden using the additional parameters on the command.
 
 ```powershell
 Add-WinFunction myFunction {param ($n) "Hi $n!"; $PSVersionTable.PSEdition }
-myFunction Bill
+PS> myFunction Bill
 ```
 
-```none
 Hi Bill!
 Desktop
-```
 
-This example defines a function called 'myFunction' with 1 parameter.
+This example defines a function called "myFunction" with 1 parameter.
 When invoked it will print a message then return the PSVersion table from the compatibility session.
 
 ## PARAMETERS
 
 ### -Name
 
-The name of the function to define.
+The name of the function to define
 
 ```yaml
 Type: System.String
@@ -65,7 +63,7 @@ Accept wildcard characters: False
 
 ### -ScriptBlock
 
-ScriptBlock to use as the body of the function.
+Scriptblock to use as the body of the function
 
 ```yaml
 Type: System.Management.Automation.ScriptBlock
@@ -81,9 +79,8 @@ Accept wildcard characters: False
 
 ### -ComputerName
 
-If you don't want to use the default compatibility session,
-use this parameter to specify the name of the computer on which to create the compatibility session.
-(Defaults to 'localhost')
+If you don't want to use the default compatibility session, use this parameter to specify the name
+of the computer on which to create the compatibility session.
 
 ```yaml
 Type: System.String
@@ -92,15 +89,15 @@ Aliases: Cn
 
 Required: False
 Position: Named
-Default value: localhost
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -ConfigurationName
 
-Specifies the configuration to connect to when creating the compatibility session.
-(Defaults to 'Microsoft.PowerShell')
+Specifies the configuration to connect to when creating the compatibility session
+(Defaults to "Microsoft.PowerShell")
 
 ```yaml
 Type: System.String
@@ -109,15 +106,14 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: 'Microsoft.PowerShell
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -Credential
 
-The credential to use when creating the compatibility session
-using the target machine/configuration
+The credential to use when creating the compatibility session using the target machine/configuration
 
 ```yaml
 Type: System.Management.Automation.PSCredential
@@ -145,4 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
+Following modifications by metablaster November 2020:
+- Added comment based help based on original comments
+- Code formatting according to the rest of project design
+- Replace double quotes with single quotes
+- Added HelpURI link to project location
+
 ## RELATED LINKS
+
+[https://github.com/PowerShell/WindowsCompatibility](https://github.com/PowerShell/WindowsCompatibility)

Modules/Ruleset.Compatibility/Help/en-US/Add-WindowsPSModulePath.md

@@ -13,7 +13,7 @@ Appends the existing Windows PowerShell PSModulePath to existing PSModulePath
 
 ## SYNTAX
 
-```none
+```powershell
 Add-WindowsPSModulePath [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -28,21 +28,22 @@ it will be appended to the end.
 
 ```powershell
 Add-WindowsPSModulePath
-Import-Module Hyper-V
+PS> Import-Module Hyper-V
 ```
 
 ### EXAMPLE 2
 
 ```powershell
 Add-WindowsPSModulePath
-Get-Module -ListAvailable
+PS> Get-Module -ListAvailable
 ```
 
 ## PARAMETERS
 
 ### -WhatIf
 
-Shows what would happen if the cmdlet runs. The cmdlet is not run.
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -86,4 +87,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
+Following modifications by metablaster November 2020:
+- Added comment based help based on original comments
+- Code formatting according to the rest of project design
+- Added HelpURI link to project location
+
 ## RELATED LINKS
+
+[https://github.com/PowerShell/WindowsCompatibility](https://github.com/PowerShell/WindowsCompatibility)

Modules/Ruleset.Compatibility/Help/en-US/Compare-WinModule.md

@@ -13,7 +13,7 @@ Compare the set of modules for this version of PowerShell against those availabl
 
 ## SYNTAX
 
-```none
+```powershell
 Compare-WinModule [[-Name] <String[]>] [-ComputerName <String>] [-ConfigurationName <String>]
  [-Credential <PSCredential>] [<CommonParameters>]
 ```
@@ -39,7 +39,7 @@ that are not currently available in the PowerShell Core environment.
 Compare-WinModule A*
 ```
 
-This will return a list of all of the compatibility session modules matching the wildcard pattern 'A*'.
+This will return a list of all of the compatibility session modules matching the wildcard pattern "A*".
 
 ## PARAMETERS
 
@@ -62,9 +62,8 @@ Accept wildcard characters: False
 
 ### -ComputerName
 
-If you don't want to use the default compatibility session,
-use this parameter to specify the name of the computer on which to create the compatibility session.
-(Defaults to 'localhost')
+If you don't want to use the default compatibility session, use this parameter to specify the name
+of the computer on which to create the compatibility session.
 
 ```yaml
 Type: System.String
@@ -73,15 +72,15 @@ Aliases: cn
 
 Required: False
 Position: Named
-Default value: localhost
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -ConfigurationName
 
-Specifies the configuration to connect to when creating the compatibility session.
-(Defaults to 'Microsoft.PowerShell')
+Specifies the configuration to connect to when creating the compatibility session
+(Defaults to "Microsoft.PowerShell")
 
 ```yaml
 Type: System.String
@@ -90,14 +89,14 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: Microsoft.PowerShell
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -Credential
 
-If needed, use this parameter to specify credentials for the compatibility session.
+If needed, use this parameter to specify credentials for the compatibility session
 
 ```yaml
 Type: System.Management.Automation.PSCredential
@@ -125,4 +124,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
+Following modifications by metablaster November 2020:
+- Added comment based help based on original comments
+- Code formatting according to the rest of project design
+- Added HelpURI link to project location
+
 ## RELATED LINKS
+
+[https://github.com/PowerShell/WindowsCompatibility](https://github.com/PowerShell/WindowsCompatibility)

Modules/Ruleset.Compatibility/Help/en-US/Copy-WinModule.md

@@ -13,7 +13,7 @@ Copy modules from the compatibility session that are directly usable in PowerShe
 
 ## SYNTAX
 
-```none
+```powershell
 Copy-WinModule [[-Name] <String[]>] [-ComputerName <String>] [-ConfigurationName <String>]
  [-Credential <PSCredential>] [-Destination <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
@@ -27,7 +27,7 @@ Once these modules have been copied,
 they will be available just like the other native modules for PowerShell Core.
 
 Note that if there already is a module in the destination corresponding to the module
-to be copied's name, it will not be copied.
+to be copied name, it will not be copied.
 
 ## EXAMPLES
 
@@ -69,9 +69,8 @@ Accept wildcard characters: False
 
 ### -ComputerName
 
-If you don't want to use the default compatibility session,
-use this parameter to specify the name of the computer on which to create the compatibility session.
-(Defaults to 'localhost')
+If you don't want to use the default compatibility session, use this parameter to specify the name
+of the computer on which to create the compatibility session.
 
 ```yaml
 Type: System.String
@@ -80,15 +79,15 @@ Aliases: cn
 
 Required: False
 Position: Named
-Default value: localhost
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -ConfigurationName
 
 Specifies the configuration to connect to when creating the compatibility session
-(Defaults to 'Microsoft.PowerShell')
+(Defaults to "Microsoft.PowerShell")
 
 ```yaml
 Type: System.String
@@ -97,7 +96,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: Microsoft.PowerShell
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
@@ -181,4 +180,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
+Following modifications by metablaster November 2020:
+- Added comment based help based on original comments
+- Code formatting according to the rest of project design
+- Added HelpURI link to project location
+
 ## RELATED LINKS
+
+[https://github.com/PowerShell/WindowsCompatibility](https://github.com/PowerShell/WindowsCompatibility)