Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

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

Open
ianwestcott opened this issue Aug 11, 2014 · 1 comment
Open

Comments

@ianwestcott
Copy link

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.

@stefansundin
Copy link

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

@therealklanni therealklanni changed the title Odd-looking URL in hubot help output Simplify URL in hubot help output, add detailed URL to README.md Apr 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants