xiph/rav1e

Contextual usage information needs improvement

Aberta

#388 aberto em 30 de jul. de 2018

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Assembly (289 forks)github user discovery
enhancementgood first issuelow prioritynew to multimedia

Métricas do repositório

Stars
 (4.144 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Examine o código de análise de argumentos da CLI e identifique onde cada mensagem de ajuda é gerada. Concentre se nos casos descritos: h, argumentos obrigatórios ausentes e valores de argumentos opcionais inválidos. Determine como fornecer informações consistentes.
Pilha de tecnologia
rust
Domain
cli
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75