Skip to content
New issue

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

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

Already on GitHub? # to your account

Get-CommandHelp could expose more help content #67

Closed
RamblingCookieMonster opened this issue Oct 4, 2017 · 2 comments
Closed

Get-CommandHelp could expose more help content #67

RamblingCookieMonster opened this issue Oct 4, 2017 · 2 comments

Comments

@RamblingCookieMonster
Copy link
Contributor

RamblingCookieMonster commented Oct 4, 2017

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!

@devblackops
Copy link
Member

devblackops commented Oct 4, 2017

Try !help foo -detailed

This definitely could be improved some (and documented better)

-Detailed basically just displays the full command help but having switches for Examples and Full could be useful as well.

@devblackops
Copy link
Member

Fixed in #71

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants