poshbotio / PoshBot

Powershell-based bot framework
MIT License
540 stars 108 forks source link

Get-CommandHelp could expose more help content #67

Closed RamblingCookieMonster closed 6 years ago

RamblingCookieMonster commented 7 years ago

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

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:

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

Cheers!

devblackops commented 7 years ago

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 commented 6 years ago

Fixed in #71