[issue41858] Fix incomplete line on optparse documentation

[Łukasz Langa]

Łukasz Langa  added the comment:


New changeset a5750cf43466f5913cdeef774f7c2dcb5943d408 by Łukasz Langa (Miss 
Islington (bot)) in branch '3.9':
bpo-41858: Clarify line in optparse doc (GH-22407)
https://github.com/python/cpython/commit/a5750cf43466f5913cdeef774f7c2dcb5943d408


--
nosy: +lukasz.langa

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Emmanuel Arias]

Emmanuel Arias  added the comment:

Thanks for the help and review!

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Tal Einat]

Tal Einat  added the comment:

Thanks for the report and the PR, Emmanuel!

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[miss-islington]

miss-islington  added the comment:


New changeset 8b2595f68af059afdd61b2bb3d32a2bf4f1662c8 by Miss Islington (bot) 
in branch '3.9':
bpo-41858: Clarify line in optparse doc (GH-22407)
https://github.com/python/cpython/commit/8b2595f68af059afdd61b2bb3d32a2bf4f1662c8


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[miss-islington]

miss-islington  added the comment:


New changeset e0e614ca99c39e107b97c7be779efea08f22ace3 by Miss Islington (bot) 
in branch '3.8':
bpo-41858: Clarify line in optparse doc (GH-22407)
https://github.com/python/cpython/commit/e0e614ca99c39e107b97c7be779efea08f22ace3


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[miss-islington]

Change by miss-islington :


--
pull_requests: +21460
pull_request: https://github.com/python/cpython/pull/22426

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[miss-islington]

Change by miss-islington :


--
nosy: +miss-islington
nosy_count: 4.0 -> 5.0
pull_requests: +21459
pull_request: https://github.com/python/cpython/pull/22425

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Terry J. Reedy]

Terry J. Reedy  added the comment:


New changeset 00eb063b6600fdb4ba5cfb99da83cc1660ec69bf by Emmanuel Arias in 
branch 'master':
bpo-41858: Clarify line in optparse doc (GH-22407)
https://github.com/python/cpython/commit/00eb063b6600fdb4ba5cfb99da83cc1660ec69bf


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Emmanuel Arias]

Emmanuel Arias  added the comment:

Hi Terry and Tal Einat,

I can't say too much because I am not English native, and my English is very 
basic.

When I read the docs and the translation from python-docs-es, that sentence 
make me feel how if something is missing, but I understand the intention with 
the Terry explanation.

I will change the patch for 

``Additionally, users can run one of the following ::``

What about now?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Tal Einat]

Tal Einat  added the comment:

I agree with Terry that the current form is not incorrect, as well as with his 
suggestion to inline the commands for printing the usage info.

--
nosy: +taleinat

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Terry J. Reedy]

Terry J. Reedy  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  ::
-h
--help
and optparse will ...

is "Additionally, users can run one of `` -h`` or `` 
--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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Emmanuel Arias]

Change by Emmanuel Arias :


--
keywords: +patch
pull_requests: +21447
stage:  -> patch review
pull_request: https://github.com/python/cpython/pull/22407

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41858] Fix incomplete line on optparse documentation

[Emmanuel Arias]

New submission from Emmanuel Arias :

This line seems to be incomplete. This fix come from the translation
to spanish of @fjsevilla-dev on 
https://github.com/python/python-docs-es/pull/758/file.
reading the proposal for the translate has sense add `the next lines`.

--
assignee: docs@python
components: Documentation
messages: 377474
nosy: docs@python, eamanu
priority: normal
severity: normal
status: open
title: Fix incomplete line on optparse documentation
versions: Python 3.10

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com