httpie/cli

Compact help

Open

#428 geöffnet am 14. Jan. 2016

Auf GitHub ansehen
 (15 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (3.676 Forks)batch import
docsenhancementhelp wantedneeds product design

Repository-Metriken

Stars
 (33.716 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Überprüfen Sie die aktuelle Hilfefunktion der httpie CLI im Quellcode, wahrscheinlich unter Verwendung von argparse. Untersuchen Sie, wie das Flag help funktioniert und wo der Verwendungstext definiert ist. Erwägen Sie, ein Flag compact help hinzuzufügen oder das Standardverhalten zu ändern, um eine kompakte Version anzuzeigen. Sehen Sie sich die Kommentare zu früheren Vorschlägen oder abgelehnten Ideen an. Implementieren Sie die Funktion, indem Sie eine neue Hilfenachricht erstellen, die nur die wesentlichen Trennzeichen für Anforderungselemente und gängige Optionen auflistet und dabei Abwärtskompatibilität gewährleistet.
Tech Stack
python
Domain
cli
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
basic Pythonfamiliarity with argparse
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70