Skip to content

Get-CommandHelp could expose more help content #67

@RamblingCookieMonster

Description

@RamblingCookieMonster

The current Get-CommandHelp function returns a limited subset of help data. In many cases, it would be valuable to include more. For example:

  • Examples
  • Parameter details
  • Everything

Possible Solution

Expand Get-CommandHelp to allow parameters similar to Get-Help. In particular:

-Examples
-Full

Why?

Consider someone somewhat new. They see the basic syntax shorthand, but there is no explanation of how a parameter should be used, no way to surface command examples, etc. outside of:

  • Reading source code for a PoshBot plugin
  • Importing the PoshBot plugin in a PowerShell session
  • Some sort of external documentation

None of these seem optimal on their own; it would be helpful (IMHO) to expose typical help info through chat as well

Cheers!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions