(doc) fix Uninstall-ChocolateyPath param #1169
Open
+32
−32
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Stunkymonkey
force-pushed
the
fix-Uninstall-ChocolateyPath
branch
from
b4a456e to
0e293c2
Compare
Stunkymonkey
changed the title
vexx32
requested changes
Apr 22, 2025
Comment on lines
+95
to
+124
| ### -Confirm | ||
| Prompts you for confirmation before running the cmdlet. | ||
|
|
||
| ```yaml | ||
| Type: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: cf | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -WhatIf | ||
| Shows what would happen if the cmdlet runs. The cmdlet is not run. | ||
|
|
||
| ```yaml | ||
| Type: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: wi | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I'm not sure why these lines were changed, these should probably be taken out if we're getting odd whitespace changes in here?
There was a problem hiding this comment.
i created #1171 as a fix. It was applied because of the .editorconfig
| @@ -32,7 +32,7 @@ Ensures that the given path is not present in the given type of PATH environment | |||
|
|
|||
| ### Example 1 | |||
| ```powershell | |||
| PS C:\> Uninstall-ChocolateyPath -PathToUninstall "$($env:SystemDrive)\tools\gittfs" | |||
| PS C:\> Uninstall-ChocolateyPath -Path "$($env:SystemDrive)\tools\gittfs" | |||
There was a problem hiding this comment.
I don't disagree with this but I think we should probably just have two example sets, one for the canonical parameter name, and one for the alias. Cause it's not wrong, it's not just not most correct atm.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
discovert a wrong parameter at
Uninstall-ChocolateyPath -PathToUninstallMotivation and Context
fixed it to
Uninstall-ChocolateyPath -PathTesting
Change Types Made
Change Checklist
Related Issue
Fixes #