argparse ArgumentParser kw args confusing translators
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
ArgumentParser documentation has subsections to detail its keyword arguments (prog, usage, description, etc.). These subsection titles are extracted for translation, and they confuse translators: they look like a normal text that one should translate (e.g. "description"). See how it looks in the extracted strings.
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
Read Doc/library/argparse.rst around the ArgumentParser keyword-argument subsections, then compare the corresponding entries in the linked argparse.pot file. Determine how the subsection titles are being extracted and verify that the keyword documentation remains clear while those titles no longer appear as translatable prose.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, localization
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100