Hide pagerduty help from default help output

drags commented 8 years ago

Help for this script was drowning out our other plugins. Moved the help text behind hubot (help pager|pager help) to quiet it down a bit.

This change is a bit unconventional for hubot script documentation, I understand this may not make master but figured the PR couldn't hurt.

stephenyeargin commented 8 years ago

Agree that this package's hubot help content is unwieldy. That said, this may be a problem best solved by some new standards on the hubot-help package that this package could adopt.

Some spitball ideas:

Only the most basic functionality would be left in the current Commands: block. (Say, limit to three)
New section in the docblock for extended help
Content of section only accessible when a user uses hubot help pager-me

Again, all of that would have to be implemented in hubot-help first and then adopted here.

/cc @technicalpickles

EDIT: Looks like more of that is handled in Hubot core than I thought (via renamedHelpCommands method)

drags commented 7 years ago

Closing to cleanup PR list

(We've been using a forked internal version for the time being, will re-engage if/when Hubot help doc handling changes)

hubot-archive / hubot-pager-me

Hide pagerduty help from default help output #77