adafruit / adafruit/circup

--help output in the readme is outdated

Open
#170 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
172
Forks
41
Avg merge
1d 20h
Merged PRs (30d)
1

Description

The --help output in the readme shows an older version of the app. One difference is the `-r / --requirement` flag being listed as an option on the main command rather than an argument for the install command, there may be other differences but this was the one that I happened to stumble upon specifically.

#130 proposes an idea to try to automate the updating of the readme output which would be nice so that there isn't a need to manually update it whenever the output has changed.

Contributor guide

Open the contributing guide

Research direction

Inspect the README's --help output and compare it with the current app help, paying particular attention to the -r/--requirement option and its install-command placement. Update the documented output to match the current command, and review #130 for the proposed automation context.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.