From 57448f9efd57f3d6658ec31f9e709c4b8f8a1e2f Mon Sep 17 00:00:00 2001 From: Keith Banner Date: Mon, 22 Jul 2019 16:58:11 -0600 Subject: [PATCH 1/3] Update UseApprovedVerbs.md I have come to this documentation a few times in the past. Get-Verb is very helpful, but the additional insight, and examples of unapproved verbs in the Microsoft docs are very helpful and make it easier to decide on a suitable replacement for an unapproved verb. I think it would be helpful to have a link to that documentation here. --- RuleDocumentation/UseApprovedVerbs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/RuleDocumentation/UseApprovedVerbs.md b/RuleDocumentation/UseApprovedVerbs.md index d2730a62f..c51b4a2d2 100644 --- a/RuleDocumentation/UseApprovedVerbs.md +++ b/RuleDocumentation/UseApprovedVerbs.md @@ -8,6 +8,8 @@ All CMDLets must used approved verbs. Approved verbs can be found by running the command `Get-Verb`. +Additional documentation on approved verbs can be found in the microsoft docs page [Approved Verbs for PowerShell Commands](https://docs.microsoft.com/en-us/powershell/developer/cmdlet/approved-verbs-for-windows-powershell-commands). If you find the verb you are using is unapproved, try searching the page for the approved equivalent. For example, if you search in the documentation for `Read`, `Open`, or `Search` you will find that the approved verb for those situations is `Get`. + ## How Change the verb in the cmdlet's name to an approved verb. From f36a89203f9e47fe04f6e715de276b5f4661d38a Mon Sep 17 00:00:00 2001 From: Keith Banner Date: Tue, 23 Jul 2019 07:58:21 -0600 Subject: [PATCH 2/3] Removed en-us from link --- RuleDocumentation/UseApprovedVerbs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RuleDocumentation/UseApprovedVerbs.md b/RuleDocumentation/UseApprovedVerbs.md index c51b4a2d2..6f782abd2 100644 --- a/RuleDocumentation/UseApprovedVerbs.md +++ b/RuleDocumentation/UseApprovedVerbs.md @@ -8,7 +8,7 @@ All CMDLets must used approved verbs. Approved verbs can be found by running the command `Get-Verb`. -Additional documentation on approved verbs can be found in the microsoft docs page [Approved Verbs for PowerShell Commands](https://docs.microsoft.com/en-us/powershell/developer/cmdlet/approved-verbs-for-windows-powershell-commands). If you find the verb you are using is unapproved, try searching the page for the approved equivalent. For example, if you search in the documentation for `Read`, `Open`, or `Search` you will find that the approved verb for those situations is `Get`. +Additional documentation on approved verbs can be found in the microsoft docs page [Approved Verbs for PowerShell Commands](https://docs.microsoft.com/powershell/developer/cmdlet/approved-verbs-for-windows-powershell-commands). If you find the verb you are using is unapproved, try searching the page for the approved equivalent. For example, if you search in the documentation for `Read`, `Open`, or `Search` you will find that the approved verb for those situations is `Get`. ## How From e92552a08dc21ee69672b62863a1dfcd1ec05695 Mon Sep 17 00:00:00 2001 From: Keith Banner Date: Tue, 23 Jul 2019 11:46:03 -0600 Subject: [PATCH 3/3] Clarified text. Broke paragraph into semantic lines. --- RuleDocumentation/UseApprovedVerbs.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/RuleDocumentation/UseApprovedVerbs.md b/RuleDocumentation/UseApprovedVerbs.md index 6f782abd2..9da65430a 100644 --- a/RuleDocumentation/UseApprovedVerbs.md +++ b/RuleDocumentation/UseApprovedVerbs.md @@ -8,7 +8,11 @@ All CMDLets must used approved verbs. Approved verbs can be found by running the command `Get-Verb`. -Additional documentation on approved verbs can be found in the microsoft docs page [Approved Verbs for PowerShell Commands](https://docs.microsoft.com/powershell/developer/cmdlet/approved-verbs-for-windows-powershell-commands). If you find the verb you are using is unapproved, try searching the page for the approved equivalent. For example, if you search in the documentation for `Read`, `Open`, or `Search` you will find that the approved verb for those situations is `Get`. +Additional documentation on approved verbs can be found in the microsoft docs page +[Approved Verbs for PowerShell Commands](https://docs.microsoft.com/powershell/developer/cmdlet/approved-verbs-for-windows-powershell-commands). +Some unapproved verbs are documented on the approved verbs page and point to approved alternatives; +try searching for the verb you used to find its approved form. +For example, searching for `Read`, `Open`, or `Search` will lead you to `Get`. ## How