xiph/rav1e

Contextual usage information needs improvement

Offen

#388 geöffnet am 30.07.2018

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Assembly (289 Forks)github user discovery
enhancementgood first issuelow prioritynew to multimedia

Repository-Metriken

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

Beschreibung

Usage information is displayed in a context-sensitive manner, but it is somewhat inconsistent:

  • Calling rav1e -h will provide a full list of arguments with information on each one
  • Omitting required arguments (input and output files) will display an example that excludes some optional arguments (RECONSTRUCTION)
  • Providing an invalid value for an optional argument will display an example that includes only required arguments and the argument that was not parsed correctly, with insufficient information (no description).

It is always possible to fall back to the -h or --help command, but contextual information could be improved.

Contributor Guide

Research-Richtung
Untersuchen Sie den Code zum Parsen von CLI Argumenten und identifizieren Sie, wo jede Hilfemeldung generiert wird. Konzentrieren Sie sich auf die beschriebenen Fälle: h, fehlende erforderliche Argumente und ungültige optionale Argumentwerte. Bestimmen Sie, wie konsistente Informationen bereitgestellt werden.
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75