ajacksified/hubot-plusplus

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

Open

#16 aberto em 11 de ago. de 2014

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)CoffeeScript (97 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (63 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Modifique a saída de ajuda em src/plusplus.coffee para remover a linha de URL da seção de comandos e adicione uma explicação detalhada da interface web no README.
Pilha de tecnologia
javascript
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80