[issue46033] Duplicated sentence in for statement documentation
New submission from Michał D <michcio1234@gmail.com>: In for statement description, there seem to be two sentences meant to mean the same:
The suite is then executed once for each item provided by the iterator, in the order returned by the iterator. Each item in turn is assigned to the target list using the standard rules for assignments (see Assignment statements), and then the suite is executed.
(from https://docs.python.org/3/reference/compound_stmts.html#the-for-statement) I believe only one of these sentences should be kept (probably the second one). If I am wrong, and the current version is actually correct, then it is unclear - to me it sounds like the iterator is iterated through twice, and suite is executed twice for each item. ---------- assignee: docs@python components: Documentation messages: 408189 nosy: docs@python, michcio1234 priority: normal severity: normal status: open title: Duplicated sentence in for statement documentation versions: Python 3.10 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46033> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- keywords: +patch nosy: +python-dev nosy_count: 2.0 -> 3.0 pull_requests: +28249 stage: -> patch review pull_request: https://github.com/python/cpython/pull/30025 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46033> _______________________________________
Vedran Čačić <vedgar@gmail.com> added the comment: How about adding the words "More precisely," at the beginning of the second sentence? ---------- nosy: +veky _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46033> _______________________________________
Michał D <michcio1234@gmail.com> added the comment: Please see the changes I suggested in my PR. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46033> _______________________________________
Vedran Čačić <vedgar@gmail.com> added the comment: Yes, it's ok. The only slight problem is that is suggests that first item is somehow special, but later it is explained that in fact it is not. :-) I would say "_Each_ item ..." (instead of "First") and without the "this is repeated for every item..." at the end, but as I said, this is also fine. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46033> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: New changeset 281f980d354d1709018a2dc77f79388faf3e56c0 by Michał D in branch 'main': bpo-46033: Clarify for-statement execution (GH-30025) https://github.com/python/cpython/commit/281f980d354d1709018a2dc77f79388faf3... ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46033> _______________________________________
Change by Terry J. Reedy <tjreedy@udel.edu>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46033> _______________________________________
participants (4)
-
Michał D -
Roundup Robot
-
Terry J. Reedy
-
Vedran Čačić