Revise argparse doc
Open
Nobody has claimed this yet.
cartridge
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
There are several problems with it:
- Not all options supported by argparse are listed. There are swim_*, issues thresholds and others.
- Cartridge.cfg options are described in cartridge module, but they should be in argparse instead.
- Information about instances.yml is lost somewhere in admin guide and repeats several times. It should be a part of argparse documentation too.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the argparse documentation, the cartridge module section, and the admin guide references to instances.yml. Identify every argparse option, move the Cartridge.cfg option descriptions into argparse, and consolidate the instances.yml information there. Done means the argparse documentation is complete without repeated or misplaced content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100