httpie/cli

Compact help

Open

#428 aberto em 14 de jan. de 2016

Ver no GitHub
 (15 comments) (0 reactions) (0 assignees)Python (3.676 forks)batch import
docsenhancementhelp wantedneeds product design

Métricas do repositório

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

Description

It would be nice if httpie had a compact help.

I tend to forget the various request item delimiters, but http --help spams the terminal scrollback with lots of unrelated information (I know, I can use less, but meh, I'm lazy). Why not include this in the compact "usage" printed when just running http?

Guia do colaborador

Direção de pesquisa
Revise a implementação atual de ajuda da CLI do httpie no código fonte, provavelmente usando argparse. Explore como a flag help funciona e onde o texto de uso é definido. Considere adicionar uma flag compact help ou modificar o comportamento padrão para mostrar uma versão condensada. Examine os comentários para sugestões anteriores ou ideias rejeitadas. Implemente o recurso criando uma nova mensagem de ajuda que liste apenas os delimitadores essenciais de itens de solicitação e opções comuns, garantindo compatibilidade com versões anteriores.
Pilha de tecnologia
python
Domain
cli
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
basic Pythonfamiliarity with argparse
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70