Skip to content

UseApprovedVerbs.md: Improving Documentation #1294

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 3 commits into from
Jul 23, 2019
Merged

UseApprovedVerbs.md: Improving Documentation #1294

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57448f9
Update UseApprovedVerbs.md
Banner-Keith Jul 22, 2019
f36a892
Removed en-us from link
Banner-Keith Jul 23, 2019
e92552a
Clarified text. Broke paragraph into semantic lines.
Jul 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions RuleDocumentation/UseApprovedVerbs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally this could be broken into semantic lines.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second sentence is backwards I think; it reads like:

If you are using an unapproved verb, try searching for its approved equivalent (which you're trying to find)

It might be worded better as:

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 Search or Open will lead you to Get.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I'll update that.


## How

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