httpie/cli

Compact help

Open

#428 ouverte le 14 janv. 2016

Voir sur GitHub
 (15 commentaires) (0 réactions) (0 assignés)Python (3 676 forks)batch import
docsenhancementhelp wantedneeds product design

Métriques du dépôt

Stars
 (33 716 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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?

Guide contributeur

Direction de recherche
Examinez l'implémentation actuelle de l'aide de la CLI httpie dans le code source, probablement en utilisant argparse. Explorez le fonctionnement du drapeau help et où le texte d'utilisation est défini. Envisagez d'ajouter un drapeau compact help ou de modifier le comportement par défaut pour afficher une version condensée. Consultez les commentaires pour les suggestions précédentes ou les idées rejetées. Implémentez la fonctionnalité en créant un nouveau message d'aide qui ne liste que les délimiteurs essentiels des éléments de requête et les options courantes, en garantissant la rétrocompatibilité.
Stack technique
python
Domaine
cli
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
basic Pythonfamiliarity with argparse
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70