argparse.ArgumentDefaultsHelpFormatter sometimes provides inaccurate documentation of defaults, so they should be overrideable
Open
Nobody has claimed this yet.
stdlib
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 558
Description
| BPO | 28742 |
|---|---|
| Nosy | @wimglenn, @pde, @tonybaloney |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2016-11-19.00:17:09.209>
labels = ['3.7', 'type-feature', 'library']
title = 'argparse.ArgumentDefaultsHelpFormatter sometimes provides inaccurate documentation of defaults, so they should be overrideable'
updated_at = <Date 2021-06-03.18:03:15.796>
user = 'https://github.com/pde'
bugs.python.org fields:
activity = <Date 2021-06-03.18:03:15.796>
actor = 'wim.glenn'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2016-11-19.00:17:09.209>
creator = 'pde'
dependencies = []
files = []
hgrepos = []
issue_num = 28742
keywords = []
message_count = 7.0
messages = ['281183', '281184', '281189', '281590', '282102', '282507', '341608']
nosy_count = 4.0
nosy_names = ['paul.j3', 'wim.glenn', 'pde', 'anthonypjshaw']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue28742'
versions = ['Python 3.7']
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 reading argparse.ArgumentDefaultsHelpFormatter and the surrounding argparse implementation to understand how defaults are rendered. Review the existing argparse tests and identify the expected override behavior for inaccurate defaults. Done means callers can override displayed defaults without breaking current formatter behavior, with tests covering the new behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100