[issue43904] Documentation for argparse, missed opportunity

[berkbayr]

New submission from berkbayr <berkbayraktar at gmail.com>:

In the API reference page for argparse, the following example is used for formatter_class:

...     formatter_class=argparse.RawDescriptionHelpFormatter,
...     description=textwrap.dedent('''\
...         Please do not mess up this text!
...         --------------------------------
...             I have indented it
...             exactly the way
...             I want it
...         '''))

I propose the example would be vastly improved by the following change:

...         Please do not mess up this text!
...         --------------------------------
...             I have indented it
...             exactly the way
...             I intended 
...         '''))

----------
assignee: docs at python
components: Documentation
messages: 391501
nosy: berkbayraktar, docs at python
priority: normal
severity: normal
status: open
title: Documentation for argparse, missed opportunity
type: enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue43904>
_______________________________________