python/cpython

[argparse] Print texts starting with capital letters and finish with dot for more formality

Closed this issue · 4 comments

BPO 45912
Nosy @ericvsmith, @lysnikolaou, @iritkatriel, @vishalpandeyvip, @silvioprog

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 = <Date 2021-11-29.14:29:26.055>
created_at = <Date 2021-11-28.02:53:41.411>
labels = ['type-feature', 'library']
title = '[argparse] Print texts starting with capital letters and finish with dot for more formality'
updated_at = <Date 2021-11-29.14:29:26.051>
user = 'https://github.com/silvioprog'

bugs.python.org fields:

activity = <Date 2021-11-29.14:29:26.051>
actor = 'eric.smith'
assignee = 'none'
closed = True
closed_date = <Date 2021-11-29.14:29:26.055>
closer = 'eric.smith'
components = ['Library (Lib)']
creation = <Date 2021-11-28.02:53:41.411>
creator = 'silvioprog'
dependencies = []
files = []
hgrepos = []
issue_num = 45912
keywords = []
message_count = 4.0
messages = ['407183', '407218', '407227', '407279']
nosy_count = 5.0
nosy_names = ['eric.smith', 'lys.nikolaou', 'iritkatriel', 'vishalpandeyvip', 'silvioprog']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45912'
versions = []

Using a simple program as example, the argparse library prints the following text:

usage: app.py [-h]

options:
-h, --help show this help message and exit

However, for more formality, it would be nice to print something like this:

Usage: app.py [-h]

Options:
-h, --help Show this help message and exit.

Notice the sentences start as capital letters and the helper string finishes with dot.

I would like to work on it as my first contribution to the python repository. Can you please assign this to me?

I don't think argparse should do such formatting. You can give it the help text in this format if that's what you want printed, and you can implement your own formatter: https://docs.python.org/3/library/argparse.html#formatter-class

I agree with @iritkatriel. Also, such a change to argparse would be too disruptive. So, I'm going to close this.