ajacksified / ajacksified/hubot-plusplus

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

オープン
#16 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement help wanted
主要言語
CoffeeScript
スター
63
フォーク
96
PR マージ指標
30日以内にマージされた PR はありません

説明

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

```
++
--
GET http:///shamu/scores[?name=][&direction=][&limit=&l...>]
[...]
```

The source of the third line above seems to be [line 16](https://github.com/ajacksified/hubot-plusplus/blob/master/src/plusplus.coffee#L16) 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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。