Skip to content

Fix Get-Help PSTypeName issue with -Parameter when only one parameter is declared#8754

Merged
adityapatwardhan merged 1 commit intoPowerShell:masterfrom
pougetat:fix-gethelp
Jan 30, 2019
Merged

Fix Get-Help PSTypeName issue with -Parameter when only one parameter is declared#8754
adityapatwardhan merged 1 commit intoPowerShell:masterfrom
pougetat:fix-gethelp

Conversation

@pougetat
Copy link

@pougetat pougetat commented Jan 26, 2019 •
edited by adityapatwardhan
Loading

PR Summary

Fix #8697 'Get-Help -Parameter does not correctly set PSTypeName when one parameter is declared'.

PR Context

This issue occurs for the following reason :

  • For a single parameter the FullHelp object contains a PSObject representing the parameter
  • For multiple parameters the FullHelp object conrains a PSObject[] with each element representing a parameter.
    My fix is to manipulate a PSObject[] instead of a PSObject even in the event that it only contains one parameter.

PR Checklist

@pougetat pougetat force-pushed the fix-gethelp branch 4 times, most recently from 0e64b17 to 1d42ef2 Compare January 26, 2019 23:10
vexx32
vexx32 reviewed Jan 26, 2019
View reviewed changes
src/System.Management.Automation/help/BaseCommandHelpInfo.cs Outdated
Copy link
Collaborator

@vexx32 vexx32 Jan 26, 2019

Choose a reason for hiding this comment

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

You could probably condense much of this into the ternary statement, if I'm reading this right...

Suggested change
paramAsPSObjArray != null ? paramAsPSObjArray : param,
paramPSObjArray == null ? paramPSObjArray : new[] { (PSObject)prmts.Properties["parameter"].Value },

Copy link
Author

@pougetat pougetat Jan 26, 2019

Choose a reason for hiding this comment

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

The problem is that param is not necessarily PSObject or PSObject[]. It can also be object which makes the cast failure prone.

Copy link
Collaborator

@vexx32 vexx32 Jan 27, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

You can do PSObject.AsPSObject(obj) to safely convert object -> PSObject, but I'm not sure whether that would completely resolve the issue.

That method will also no-op if the input object is already a PSObject.

Copy link
Author

@pougetat pougetat Jan 27, 2019

Choose a reason for hiding this comment

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

I don't think it resolves the issue since that method will attempt to create a PSObject from object. What I'm doing here is essentially trying to use the object as is in the form of a PSObject and if it doesn't work then I will just pass the object along to ConvertTo as was done previously. ConvertTo itself knows what to do with a plain object in regards to transforming it into a PSObject.

Copy link
Collaborator

@vexx32 vexx32 Jan 27, 2019

Choose a reason for hiding this comment

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

I'm not 100% sure, but I think that's more or less just what ConvertTo would do itself... I'd have to chase down the convoluted code paths in there, though. I'm sure it's OK to use ConvertTo, though. 🙂

@pougetat pougetat force-pushed the fix-gethelp branch 4 times, most recently from 40bca28 to 0c67a87 Compare January 27, 2019 10:49
adityapatwardhan
adityapatwardhan requested changes Jan 28, 2019
View reviewed changes
@adityapatwardhan adityapatwardhan self-assigned this Jan 28, 2019
@adityapatwardhan adityapatwardhan changed the title Fix Get-Help issue wih -Parameter option #8697 Fix Get-Help PSTypeName issue with -Parameter when only one parameter is declared Jan 30, 2019
@adityapatwardhan adityapatwardhan merged commit 1d7651f into PowerShell:master Jan 30, 2019
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Jan 30, 2019

@pougetat Thank you for your contribution!

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jan 30, 2019
@pougetat pougetat deleted the fix-gethelp branch April 8, 2019 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adityapatwardhan adityapatwardhan adityapatwardhan approved these changes

@Francisco-Gamino Francisco-Gamino Awaiting requested review from Francisco-Gamino

+1 more reviewer

@vexx32 vexx32 vexx32 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@adityapatwardhan adityapatwardhan

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Get-Help -Parameter does not correctly set PSTypeName when one parameter is declared

5 participants

@pougetat @adityapatwardhan @vexx32 @iSazonov @throwaway774