xiph/rav1e

Contextual usage information needs improvement

Open

#388 opened on Jul 30, 2018

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Assembly (289 forks)github user discovery
enhancementgood first issuelow prioritynew to multimedia

Repository metrics

Stars
 (4,144 stars)
PR merge metrics
 (No merged PRs in 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.

Contributor guide

Research direction
Examine the CLI argument parsing code and identify where each help message is generated. Focus on the cases described: h, missing required args, and invalid optional arg values. Determine how to provide consistent information.
Tech stack
rust
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75