Message 377512 - Python tracker

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author	terry.reedy
Recipients	docs@python, eamanu, terry.reedy
Date	2020-09-25.23:43:20
SpamBayes Score	-1.0
Marked as misclassified	Yes
Message-id	<1601077400.11.0.360153875621.issue41858@roundup.psfhosted.org>
In-reply-to

Content
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.

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.

History
Date	User	Action	Args
2020-09-25 23:43:20	terry.reedy	set	recipients: + terry.reedy, docs@python, eamanu
2020-09-25 23:43:20	terry.reedy	set	messageid: <1601077400.11.0.360153875621.issue41858@roundup.psfhosted.org>
2020-09-25 23:43:20	terry.reedy	link	issue41858 messages
2020-09-25 23:43:20	terry.reedy	create