Skip to content

Fix typo in .Description for Measure-RequiresModules #888

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
JamesWTruher merged 2 commits into from
Feb 15, 2018
Merged

Fix typo in .Description for Measure-RequiresModules #888

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3804b5
Fix typo in comment-based help
TimCurwick Feb 14, 2018
4625f58
Added to typo fix
TimCurwick Feb 14, 2018
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
4 changes: 2 additions & 2 deletions Tests/Engine/CommunityAnalyzerRules/CommunityAnalyzerRules.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ function Measure-RequiresRunAsAdministrator
.DESCRIPTION
The #Requires statement prevents a script from running unless the Windows PowerShell version, modules, snap-ins, and module and snap-in version prerequisites are met.
From Windows PowerShell 3.0, the #Requires statement let script developers specify Windows PowerShell modules that the script requires.
To fix a violation of this rule, please consider to use #Requires -RunAsAdministrator instead of using Import-Module.
To fix a violation of this rule, please consider to use #Requires -Modules instead of using Import-Module.
Copy link
Collaborator

@bergmeister bergmeister Feb 14, 2018

Choose a reason for hiding this comment

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

Thanks for the contribution. The fix of this copy-paste mistake makes sense.
However, by looking at the documentation here, I think it would be better to state the full synax:
#Requires -Modules { <Module-Name> | <Hashtable> }

.EXAMPLE
Measure-RequiresModules -ScriptBlockAst $ScriptBlockAst
.INPUTS
Expand Down Expand Up @@ -938,4 +938,4 @@ function Measure-HelpNote
}
}

Export-ModuleMember -Function Measure*
Export-ModuleMember -Function Measure*