Directly integrate Help subtopics of -Detailed, -Examples into commandlette - by Stephen Owen

Status : 


Sign in
to vote
ID 797866 Comments
Status Active Workarounds
Type Suggestion Repros 0
Opened 8/20/2013 7:43:04 AM
Access Restriction Public


I submit that it would be a useful ammendment to add the -Detailed and -Examples Get-help topics directly into the commandlettes themselves.  I think this would save unnecessary keystrokes as users encounter commands, and could completely remove the need for the get-help command entirely (perhaps).  Here is an example of a useage scenario:

  User is trying to determine how to recursively search for files in a directory and needs to reference help.  Rather than clear out a long string, the user could append -Detailed, -Help, or -Examples to their command.  I have thought of two possible behaviors for the command from here, which I will include for discussion.

  1.) Appending -Detailed to a commandline will display the (Get-Help Commandlette -Detailed) information about only the parameters the user has typed thus far.
  2.) Appending -Detailed to a commandline will display all of the available help for that commandlette
  This sort of behavior would also empower new usage scenarios.  For instance, if a user is having an issue with a commandlette, appending -Help could grow into a sort of Parameter or Type-Checking autocorrect.  I forsee this as being a potential boon to Powershell users.
Sign in to post a comment.