kurusugawa-computer / kurusugawa-computer/annofab-cli
[REQ][document] コマンドヘルプの書き方
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- Python
- Stars
- 8
- Forks
- 0
- Avg merge
- 51m
- Merged PRs (30d)
- 12
Description
現状
--by_count BY_COUNT
提案
JSONであることを記載するとよいかも。
--by_count BY_COUNT_JSON
Contributor guide
No contributing guide indexed for this repository
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
Find the CLI help definition for --by_count and inspect how its metavar is rendered. Update the help text to identify the value as JSON, then verify that the command help displays BY_COUNT_JSON.
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
- 45/100