Rename AutomaticallyWritePowerShellTipOption to WritePowerShellTipCondition

Author: deadlydog

ReadMe.md

@@ -144,19 +144,19 @@ Possible values for the `-AutomaticallyWritePowerShellTip` parameter are `Never`
 Tips will only be automatically shown in interactive PowerShell sessions.
 This prevents them from appearing unexpectedly when running scripts or other automated processes.
 
-#### Write only unshown tips
+#### Do not show the same tips twice
 
-By default, tiPS will cycle through all available tips.
-If you prefer to only see tips that you haven't shown before, you can configure tiPS to only show unshown tips by running:
+By default, tiPS will cycle through all available tips, so once all tips have been shown it will restart and display them again.
+If you prefer to only see tips that haven't been shown before, you can configure tiPS to only show unshown tips by running:
 
 ```powershell
-Set-TiPSConfiguration -AutomaticallyWritePowerShellTipOption OnlyWriteUnshownTips
+Set-TiPSConfiguration -WritePowerShellTipCondition OnlyWriteUnshownTips
 ```
 
-Possible values for the `-AutomaticallyWritePowerShellTipOption` parameter are `CycleThroughTips` (default) and `OnlyWriteUnshownTips`.
+Possible values for the `-WritePowerShellTipCondition` parameter are `CycleThroughTips` (default) and `OnlyWriteUnshownTips`.
 
 When `OnlyWriteUnshownTips` is used, tiPS will only automatically display a tip if there are tips that have not been shown yet.
-Once all tips have been shown, no more tips will be automatically displayed until new tips are added to the module (typically by updating the module).
+Once all tips have been shown, no more tips will be displayed until new tips are added (by updating the module).
 
 ### ⬆️ Automatic updates
 

src/tiPS/Public/Set-TiPSConfiguration.ps1

@@ -24,10 +24,10 @@ function Set-TiPSConfiguration
 	Whether to automatically write a PowerShell tip at session startup.
 	Valid values are Never, EverySession, Daily, Weekly, Biweekly, and Monthly. Default is Never.
 
-	.PARAMETER AutomaticallyWritePowerShellTipOption
+	.PARAMETER WritePowerShellTipCondition
 	Controls how tips are selected when automatically showing tips.
 	Valid values are CycleThroughTips (default) and OnlyWriteUnshownTips.
-	OnlyWriteUnshownTips will only show tips that have not been shown yet.
+	OnlyWriteUnshownTips will only show tips that have not been shown before.
 
 	.PARAMETER TipRetrievalOrder
 	The order in which to retrieve PowerShell tips.
@@ -67,7 +67,7 @@ function Set-TiPSConfiguration
 	Set the tiPS configuration to retrieve PowerShell tips in random order.
 
 	.EXAMPLE
-	Set-TiPSConfiguration -AutomaticallyWritePowerShellTip Daily -AutomaticallyWritePowerShellTipOption OnlyWriteUnshownTips
+	Set-TiPSConfiguration -AutomaticallyWritePowerShellTip Daily -WritePowerShellTipCondition OnlyWriteUnshownTips
 
 	Set the tiPS configuration to automatically write a PowerShell tip every day, but only if there are tips that have not been shown yet.
 #>
@@ -86,7 +86,7 @@ function Set-TiPSConfiguration
 		[tiPS.WritePowerShellTipCadence] $AutomaticallyWritePowerShellTip = [tiPS.WritePowerShellTipCadence]::Never,
 
 		[Parameter(Mandatory = $false, ParameterSetName = 'PartialConfiguration', ValueFromPipelineByPropertyName = $true)]
-		[tiPS.WritePowerShellTipConditions] $AutomaticallyWritePowerShellTipOption = [tiPS.WritePowerShellTipConditions]::CycleThroughTips,
+		[tiPS.WritePowerShellTipConditions] $WritePowerShellTipCondition = [tiPS.WritePowerShellTipConditions]::CycleThroughTips,
 
 		[Parameter(Mandatory = $false, ParameterSetName = 'PartialConfiguration', ValueFromPipelineByPropertyName = $true)]
 		[Alias('TipOrder')]
@@ -131,12 +131,12 @@ function Set-TiPSConfiguration
 			}
 		}
 
-		# If the AutomaticallyWritePowerShellTipOption parameter is passed in, set it.
-		if ($PSBoundParameters.ContainsKey('AutomaticallyWritePowerShellTipOption'))
+		# If the WritePowerShellTipCondition parameter is passed in, set it.
+		if ($PSBoundParameters.ContainsKey('WritePowerShellTipCondition'))
 		{
 			if ($PSCmdlet.ShouldProcess('tiPS configuration WritePowerShellTipCondition property', 'Set'))
 			{
-				$script:TiPSConfiguration.WritePowerShellTipCondition = $AutomaticallyWritePowerShellTipOption
+				$script:TiPSConfiguration.WritePowerShellTipCondition = $WritePowerShellTipCondition
 			}
 		}