sharpbracket/redshift

Show default values in help output

Open

#597 opened on Mar 15, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (429 forks)auto 404
help wanted

Repository metrics

Stars
 (6,156 stars)
PR merge metrics
 (PR metrics pending)

Description

Could you please give more information on the options in the command outputs? For example:

  • what is the default adjustment method used? (could be mentioned in the redshift -m list output)
  • what is the current adjustment method used? (could be mentioned in redshift -m list and redshift -v output)
  • what are the default adjustment method options (like screen, card, crtc, preserve)? (could be mentioned in redshift -m METHOD:help)
  • what are the current adjustment method options (like screen, card, crtc, preserve)? (could be mentioned in redshift -v)
  • where can I get more information on the adjustment method options (like what are the available screen, card and crtc numbers on my system)? (could be mentioned in redshift -m METHOD:help)
  • how does one separate more than one adjustment method options - with comma, space or something else? (could be mentioned in redshift -m METHOD:help)

Contributor guide

Research direction
Look for help text definitions in the source code (likely in src/ directory). Identify where command line options and their defaults are printed. Add default values next to each option. For example, in help strings like 'Adjustment method: screen', change to 'Adjustment method: screen (default)'. Also ensure consistency across all help outputs.
Tech stack
c
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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.
85