Retrieving help text in Python
Open
Nobody has claimed this yet.
area/help
type/documentation
type/enhancement
type/proposal
- Dominant language
- Python
- Stars
- 358
- Forks
- 101
- PR merge metrics
- No merged PRs in 30d
Description
Is there currently a way to validate that all commands and arguments have documentation through as seen through -h? If not, are there suggested implementations for this validation and/or will this be potentially added in future releases?
Thanks!
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
No files or tests are named. Start by locating the command and argument help-generation paths and checking whether a validation entry point exists; done would be a documented, repeatable check that every command and argument appears in -h output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100