hubot-plusplus icon indicating copy to clipboard operation
hubot-plusplus copied to clipboard

Simplify URL in `hubot help` output, add detailed URL to README.md

Open ianwestcott opened this issue 11 years ago • 1 comments

I've noticed some odd output when querying my hubot instance for help:

<name>++
<name>--
GET http://<url>/shamu/scores[?name=<name>][&direction=<top|botton>][&limit=&l...>]
[...]

The source of the third line above seems to be line 16 of plusplus' documentation section, which I gather describes a method of looking up scores via web interface. It's hard to understand in this context, though, and (as you can see by the quoted text above) gets garbled by auto-linkifiers on services such as HipChat.

Is there a reason why that line is included in the Commands: section of Hubot's help docs? IMO this functionality would be better outlined in the Description section so as not to clutter the output of a hubot help query. This would also allow you to expound on its usage in a clearer and more comprehensive way.

ianwestcott avatar Aug 11 '14 18:08 ianwestcott

Agreed. This kinda belongs here on Github in README.md, it's bloating the help output.

stefansundin avatar Oct 21 '14 18:10 stefansundin