spinel-coop/rv

Add back long help (in a more consistent way)

Open

#431 geöffnet am 28. Jan. 2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (46 Forks)user submission
good first issue

Repository-Metriken

Stars
 (1.706 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 4T 18h) (14 gemergte PRs in 30 T)

Beschreibung

Today, we have re-routed all four forms of help to only show the short help, the default clap provides on -h.

Instead, let's provide both long and short help, like this:

  • Global -h on any command, like rv ruby pin -h: show short help
  • Global --help on any command, like rv ruby pin --help: show short help
  • rv help [NAME], like rv help ruby pin: show long help
  • rv NAME help, like rv ruby help pin or rv ruby pin help: removed, it's confusing to have many help commands

Contributor Guide

Research-Richtung
Untersuche die Konfiguration des Hilfesystems von clap, um zwischen kurzer und langer Hilfe zu unterscheiden. Ändere die Befehlsdefinitionen mit `clap::Command::help template` und behandle das ` help` Flag, um die kurze Hilfe anzuzeigen, während `rv help [Unterbefehl]` die lange Hilfe anzeigt. Überprüfe vorhandene Tests und aktualisiere sie entsprechend.
Tech Stack
rust
Domain
cli
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitRust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75