Skip to content

Useful error message when HelpMessage attributes are empty string#4334

Merged
daxian-dbw merged 1 commit intoPowerShell:masterfrom
SteveL-MSFT:helpmessage
Jul 26, 2017
Merged

Useful error message when HelpMessage attributes are empty string#4334
daxian-dbw merged 1 commit intoPowerShell:masterfrom
SteveL-MSFT:helpmessage

Conversation

@SteveL-MSFT
Copy link
Copy Markdown
Member

@SteveL-MSFT SteveL-MSFT commented Jul 24, 2017

Fix invalid value error message on some cmdlet attributes to point to the specific attribute.

Removed wrapping of argument exception into not useful requires exception

Before:

.\helpmessage.ps1 : Cannot process the #requires statement because it is not in the correct format.
The #requires statement must be in one of the following formats:
 "#requires -shellid <shellID>"
 "#requires -version <major.minor>"
 "#requires -psedition <edition>"
 "#requires -pssnapin <psSnapInName> [-version <major.minor>]"
 "#requires -modules <ModuleSpecification>"
 "#requires -runasadministrator"
At line:1 char:1
+ .\helpmessage.ps1
+ ~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (helpmessage.ps1:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : ScriptRequiresInvalidFormat

After:

Cannot process argument because the value of argument "HelpMessage" is not valid. Change the value of the
"HelpMessage" argument and run the operation again.
At line:1 char:1
+ .\helpmessage.ps1
+ ~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [], RuntimeException
    + FullyQualifiedErrorId : Argument

Fix #4331

@SteveL-MSFT
Fix invalid value error message on some cmdlet attributes to point to…
13f8a04 
… the specific attribute.

Removed wrapping of argument exception into not useful requires exception
@SteveL-MSFT SteveL-MSFT requested a review from daxian-dbw July 24, 2017 20:23
lzybkr
lzybkr approved these changes Jul 24, 2017
View reviewed changes
Copy link
Copy Markdown
Contributor

@lzybkr lzybkr left a comment

Choose a reason for hiding this comment

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

I sign off assuming the #requires error message has not degraded from this change.

@SteveL-MSFT
Copy link
Copy Markdown
Member Author

SteveL-MSFT commented Jul 24, 2017

@lzybkr ScriptRequiresException still gets thrown in all other cases

@daxian-dbw daxian-dbw merged commit 0cd7a4a into PowerShell:master Jul 26, 2017
@SteveL-MSFT SteveL-MSFT deleted the helpmessage branch July 26, 2017 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

+1 more reviewer

@lzybkr lzybkr lzybkr approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@adityapatwardhan adityapatwardhan

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@SteveL-MSFT @daxian-dbw @lzybkr @msftclas @adityapatwardhan