adafruit / adafruit/circup

Auotgenerate the --help output for the README

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

Description

This is a nice write up of how to use cog to automatically add tool --help ouput to a README file and test that it is up to date as well.

https://til.simonwillison.net/python/cog-to-update-help-in-readme

Contributor guide

Open the contributing guide

Research direction

Start by reading the linked Cog write-up and inspecting how circup currently documents its --help output in the README. Identify the command or documentation entry point involved; done means the README help text is generated automatically and a check can detect when it is out of date. No file or test path is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.