xiph/rav1e

Contextual usage information needs improvement

Ouverte

#388 ouverte le 30 juil. 2018

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Assembly (289 forks)github user discovery
enhancementgood first issuelow prioritynew to multimedia

Métriques du dépôt

Stars
 (4 144 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Examinez le code d'analyse des arguments CLI et identifiez où chaque message d'aide est généré. Concentrez vous sur les cas décrits : h, arguments obligatoires manquants et valeurs d'arguments optionnels invalides. Déterminez comment fournir des informations cohérentes.
Stack technique
rust
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.
2
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75