sphinx-doc / sphinx-doc/sphinx-argparse
Positional args don't render metavar
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 38
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
Output on command line:
-j <N> maximum number of processes to run in parallel
Output in web is missing the <N>:
-j
maximum number of processes to run in parallel
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
Start by locating the rendering path for argparse positional arguments and compare its web output with the command-line output shown in the issue. Verify the change by reproducing the example and confirming that the web output includes the metavar alongside -j.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100