From 2dce434e4c042b10ab5d23876885c1bb54bae349 Mon Sep 17 00:00:00 2001 From: Carterpersall Date: Tue, 3 Oct 2023 12:03:13 -0500 Subject: [PATCH] More Grammar and Formatting --- functions/private/Get-WinUtilInstallerProcess.ps1 | 2 +- functions/private/Get-WinUtilRegistry.ps1 | 5 ++--- functions/private/Get-WinUtilToggleStatus.ps1 | 2 +- functions/private/Install-WinUtilChoco.ps1 | 4 ++-- functions/private/Install-WinUtilWinget.ps1 | 2 +- functions/private/Invoke-WinUtilBingSearch.ps1 | 2 +- functions/private/Invoke-WinUtilCurrentSystem.ps1 | 4 +--- functions/private/Invoke-WinUtilDarkMode.ps1 | 2 +- functions/private/Invoke-WinUtilFeatureInstall.ps1 | 2 +- functions/private/Invoke-WinUtilScript.ps1 | 2 +- functions/private/Invoke-WinUtilTweaks.ps1 | 2 +- functions/private/Remove-WinUtilAPPX.ps1 | 2 +- functions/private/Set-WinUtilDNS.ps1 | 2 +- functions/private/Set-WinUtilRegistry.ps1 | 2 +- functions/private/Set-WinUtilRestorePoint.ps1 | 2 +- functions/private/Set-WinUtilScheduledTask.ps1 | 2 +- functions/private/Set-WinUtilService.ps1 | 2 +- functions/private/Set-WinUtilUiTheme.ps1 | 2 +- 18 files changed, 20 insertions(+), 23 deletions(-) diff --git a/functions/private/Get-WinUtilInstallerProcess.ps1 b/functions/private/Get-WinUtilInstallerProcess.ps1 index a297b539bf..0749576814 100644 --- a/functions/private/Get-WinUtilInstallerProcess.ps1 +++ b/functions/private/Get-WinUtilInstallerProcess.ps1 @@ -2,7 +2,7 @@ function Get-WinUtilInstallerProcess { <# .DESCRIPTION - Meant to check for running processes and will return a boolean response + Meant to check for running processes, will return a boolean response #> diff --git a/functions/private/Get-WinUtilRegistry.ps1 b/functions/private/Get-WinUtilRegistry.ps1 index 33345a2099..28240747ff 100644 --- a/functions/private/Get-WinUtilRegistry.ps1 +++ b/functions/private/Get-WinUtilRegistry.ps1 @@ -2,11 +2,10 @@ function Get-WinUtilRegistry { <# .DESCRIPTION - This function will make all modifications to the registry + Gets the value of a registry key .EXAMPLE - - Set-WinUtilRegistry -Name "PublishUserActivities" -Path "HKLM:\SOFTWARE\Policies\Microsoft\Windows\System" -Type "DWord" -Value "0" + Get-WinUtilRegistry -Name "PublishUserActivities" -Path "HKLM:\SOFTWARE\Policies\Microsoft\Windows\System" -Type "DWord" -Value "0" #> param ( diff --git a/functions/private/Get-WinUtilToggleStatus.ps1 b/functions/private/Get-WinUtilToggleStatus.ps1 index a9742ff5e2..15027569cd 100644 --- a/functions/private/Get-WinUtilToggleStatus.ps1 +++ b/functions/private/Get-WinUtilToggleStatus.ps1 @@ -2,7 +2,7 @@ Function Get-WinUtilToggleStatus { <# .DESCRIPTION - Meant to pull the registry keys for a toggle switch and returns true or false + Pulls the registry keys for a toggle switch and returns true or false True should mean status is enabled False should mean status is disabled diff --git a/functions/private/Install-WinUtilChoco.ps1 b/functions/private/Install-WinUtilChoco.ps1 index 6b77587223..0a246f8d30 100644 --- a/functions/private/Install-WinUtilChoco.ps1 +++ b/functions/private/Install-WinUtilChoco.ps1 @@ -3,7 +3,7 @@ function Install-WinUtilChoco { <# .DESCRIPTION - Function is meant to ensure Choco is installed + Installs Chocolatey if it is not installed #> @@ -16,7 +16,7 @@ function Install-WinUtilChoco { } Write-Host "Seems Chocolatey is not installed, installing now?" - # Let user decide if he wants to install Chocolatey + # Let user decide if they want to install Chocolatey $confirmation = Read-Host "Are you Sure You Want To Proceed:(y/n)" if ($confirmation -eq 'y') { Set-ExecutionPolicy Bypass -Scope Process -Force; Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1')) -ErrorAction Stop diff --git a/functions/private/Install-WinUtilWinget.ps1 b/functions/private/Install-WinUtilWinget.ps1 index 3f07a92513..09bff00d68 100644 --- a/functions/private/Install-WinUtilWinget.ps1 +++ b/functions/private/Install-WinUtilWinget.ps1 @@ -5,7 +5,7 @@ function Get-LatestHash { $WebClient.DownloadFile($shaUrl, $shaFile) Get-Content $shaFile - } +} function Install-WinUtilWinget { diff --git a/functions/private/Invoke-WinUtilBingSearch.ps1 b/functions/private/Invoke-WinUtilBingSearch.ps1 index 4a4154ca4f..bd3cdf522a 100644 --- a/functions/private/Invoke-WinUtilBingSearch.ps1 +++ b/functions/private/Invoke-WinUtilBingSearch.ps1 @@ -2,7 +2,7 @@ function Invoke-WinUtilBingSearch { <# .DESCRIPTION - Sets Bing Search on or off + Disables/Enables Bing Search #> Param($Enabled) diff --git a/functions/private/Invoke-WinUtilCurrentSystem.ps1 b/functions/private/Invoke-WinUtilCurrentSystem.ps1 index ba8d30225b..23a6d2d444 100644 --- a/functions/private/Invoke-WinUtilCurrentSystem.ps1 +++ b/functions/private/Invoke-WinUtilCurrentSystem.ps1 @@ -3,9 +3,7 @@ Function Invoke-WinUtilCurrentSystem { <# .DESCRIPTION - Function is meant to read existing system registry and check according configuration. - - Example: Is telemetry enabled? check the box. + Checks to see what tweaks have already been applied, and checks the according boxes .EXAMPLE diff --git a/functions/private/Invoke-WinUtilDarkMode.ps1 b/functions/private/Invoke-WinUtilDarkMode.ps1 index decda16a17..7a497798ad 100644 --- a/functions/private/Invoke-WinUtilDarkMode.ps1 +++ b/functions/private/Invoke-WinUtilDarkMode.ps1 @@ -2,7 +2,7 @@ Function Invoke-WinUtilDarkMode { <# .DESCRIPTION - Sets Dark Mode on or off + Enables/Disables Dark Mode #> Param($DarkMoveEnabled) diff --git a/functions/private/Invoke-WinUtilFeatureInstall.ps1 b/functions/private/Invoke-WinUtilFeatureInstall.ps1 index e5968ee5ad..81e9eac0cf 100644 --- a/functions/private/Invoke-WinUtilFeatureInstall.ps1 +++ b/functions/private/Invoke-WinUtilFeatureInstall.ps1 @@ -2,7 +2,7 @@ function Invoke-WinUtilFeatureInstall { <# .DESCRIPTION - This function converts all the values from the tweaks.json and routes them to the appropriate function + Converts all the values from the tweaks.json and routes them to the appropriate function #> diff --git a/functions/private/Invoke-WinUtilScript.ps1 b/functions/private/Invoke-WinUtilScript.ps1 index 329f76f953..f44ad7da83 100644 --- a/functions/private/Invoke-WinUtilScript.ps1 +++ b/functions/private/Invoke-WinUtilScript.ps1 @@ -2,7 +2,7 @@ function Invoke-WinUtilScript { <# .DESCRIPTION - This function will run a separate powershell script. Meant for things that can't be handled with the other functions + Invokes the provided scriptblock. Intended for things that can't be handled with the other functions .EXAMPLE diff --git a/functions/private/Invoke-WinUtilTweaks.ps1 b/functions/private/Invoke-WinUtilTweaks.ps1 index a345b0a18f..a53a42dd61 100644 --- a/functions/private/Invoke-WinUtilTweaks.ps1 +++ b/functions/private/Invoke-WinUtilTweaks.ps1 @@ -2,7 +2,7 @@ function Invoke-WinUtilTweaks { <# .DESCRIPTION - This function converts all the values from the tweaks.json and routes them to the appropriate function + Converts all the values from the tweaks.json and routes them to the appropriate function #> diff --git a/functions/private/Remove-WinUtilAPPX.ps1 b/functions/private/Remove-WinUtilAPPX.ps1 index dd6c25bdb3..458a3204d1 100644 --- a/functions/private/Remove-WinUtilAPPX.ps1 +++ b/functions/private/Remove-WinUtilAPPX.ps1 @@ -2,7 +2,7 @@ function Remove-WinUtilAPPX { <# .DESCRIPTION - This function will remove any of the provided APPX names + Removes all APPX packages that match the given name .EXAMPLE diff --git a/functions/private/Set-WinUtilDNS.ps1 b/functions/private/Set-WinUtilDNS.ps1 index daf7e7522e..b3088f4e29 100644 --- a/functions/private/Set-WinUtilDNS.ps1 +++ b/functions/private/Set-WinUtilDNS.ps1 @@ -2,7 +2,7 @@ function Set-WinUtilDNS { <# .DESCRIPTION - This function will set the DNS of all interfaces that are in the "Up" state. It will lookup the values from the DNS.Json file + Sets the DNS of all interfaces that are in the "Up" state. It will lookup the values from the DNS.Json file .EXAMPLE diff --git a/functions/private/Set-WinUtilRegistry.ps1 b/functions/private/Set-WinUtilRegistry.ps1 index 58be434538..2d89768597 100644 --- a/functions/private/Set-WinUtilRegistry.ps1 +++ b/functions/private/Set-WinUtilRegistry.ps1 @@ -2,7 +2,7 @@ function Set-WinUtilRegistry { <# .DESCRIPTION - This function will make all modifications to the registry + Modifies the registry based on the given inputs .EXAMPLE diff --git a/functions/private/Set-WinUtilRestorePoint.ps1 b/functions/private/Set-WinUtilRestorePoint.ps1 index 3fd73403be..c29b7f23b1 100644 --- a/functions/private/Set-WinUtilRestorePoint.ps1 +++ b/functions/private/Set-WinUtilRestorePoint.ps1 @@ -2,7 +2,7 @@ function Set-WinUtilRestorePoint { <# .DESCRIPTION - This function will make a Restore Point + Creates a Restore Point #> diff --git a/functions/private/Set-WinUtilScheduledTask.ps1 b/functions/private/Set-WinUtilScheduledTask.ps1 index fc1c07e3a5..f46b1a5754 100644 --- a/functions/private/Set-WinUtilScheduledTask.ps1 +++ b/functions/private/Set-WinUtilScheduledTask.ps1 @@ -2,7 +2,7 @@ function Set-WinUtilScheduledTask { <# .DESCRIPTION - This function will enable/disable the provided Scheduled Task + Enables/Disables the provided Scheduled Task .EXAMPLE diff --git a/functions/private/Set-WinUtilService.ps1 b/functions/private/Set-WinUtilService.ps1 index ee03944b15..878ac1ecee 100644 --- a/functions/private/Set-WinUtilService.ps1 +++ b/functions/private/Set-WinUtilService.ps1 @@ -2,7 +2,7 @@ Function Set-WinUtilService { <# .DESCRIPTION - This function will change the startup type of services and start/stop them as needed + Changes the startup type of services and starts/stops them as needed .EXAMPLE diff --git a/functions/private/Set-WinUtilUiTheme.ps1 b/functions/private/Set-WinUtilUiTheme.ps1 index 5cd3eeb7b5..83ca9ba343 100644 --- a/functions/private/Set-WinUtilUiTheme.ps1 +++ b/functions/private/Set-WinUtilUiTheme.ps1 @@ -2,7 +2,7 @@ function Set-WinUtilUITheme { <# .DESCRIPTION - This function will set theme to the XAML file + Sets the theme of the XAML file .EXAMPLE