Skip to content

Commit

Permalink
UseApprovedVerbs.md: Improving Documentation (#1294)
Browse files Browse the repository at this point in the history
* 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.

* Removed en-us from link

* Clarified text. Broke paragraph into semantic lines.
  • Loading branch information
Banner-Keith authored and rjmholt committed Jul 23, 2019
1 parent fdbdf05 commit 17e9677
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions RuleDocumentation/UseApprovedVerbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ 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).
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

Change the verb in the cmdlet's name to an approved verb.
Expand Down

0 comments on commit 17e9677

Please sign in to comment.