[issue41858] Fix incomplete line on optparse documentation

Terry J. Reedy report at bugs.python.org
Fri Sep 25 19:43:20 EDT 2020


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I can see how the current phrasing gives one pause, and might seem incomplete, but it is not incorrect.  The sense of

Additionally, users can run one of  ::
   <yourscript> -h
   <yourscript> --help
and optparse will ...

is "Additionally, users can run one of ``<yourscript> -h`` or ``<yourscript> --help`` and optparse will ...".  I personally prefer this running text form with in-line code markup to the block form.  What do you think?

If we keep the block form, I slightly prefer 'one of the following' to 'one of the next lines' but cannot say why.

----------
nosy: +terry.reedy

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


More information about the Python-bugs-list mailing list