Skip to content

Commit ec6d2d7

Browse files
committed
Clarify paragraph def for ParagraphHelpFormatter
1 parent 2b30019 commit ec6d2d7

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

Doc/library/argparse.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -364,10 +364,13 @@ one. If you wish to preserve multiple blank lines, add spaces between the
364364
newlines.
365365

366366
:class:`ParagraphHelpFormatter` wraps description and help text like the
367-
default formatter, while preserving paragraphs and supporting bulleted lists.
368-
Bullet list items are recognized by markers such as "*", "-", "+", or ">"
369-
characters, or by alphanumeric sequences followed by "." or ")" (e.g. 1., a),
370-
iv.)::
367+
default formatter, while preserving paragraphs. Parapgraphs are separated by
368+
blank lines. Blocks of text separated by a single return are merged into a
369+
single paragraph.
370+
371+
Bullet lists are supported. Text for a bullet item is wrapped with appropriate
372+
indentation. Bullet list items are recognized by markers such as "*", "-", "+",
373+
or ">" characters, or by alphanumeric sequences followed by "." or ")".::
371374

372375
>>> parser = argparse.ArgumentParser(
373376
... prog='PROG',

0 commit comments

Comments
 (0)