Issue 34611: some examples in 'itertools' modules docs are inaccuracy. (original) (raw)

Issue34611

Created on 2018-09-08 07:21 by taketakeyyy@gmail.com, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 9120 closed taketakeyyy@gmail.com,2018-09-09 03:56
Messages (3)
msg324830 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2018-09-08 11:03
@taketakeyyy: Did you mean to include information about *which* examples are inaccurate? This issue isn't really useful without that information.
msg324871 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2018-09-09 05:45
I don't know if it's worth it to edit the results to return Python data structures in the linked PR. The current version is more concise and indicates the general result of the function instead of the actual return values of the function calls which is intentional. Maybe is there some example in itertools that you are referring to that has incorrect results? Thanks
msg324872 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2018-09-09 06:35
I concur with Karthikeyan. The doc examples read fine as-is. They have worked well for many users for a long time. It only takes seconds of experimentation to see exactly what is returned. There is also a plain text description and a rough pure python equivalent. Marking this as not a bug. Thank you for looking at the docs, but I'm going to pass on this particular suggestion.
History
Date User Action Args
2022-04-11 14:59:05 admin set github: 78792
2018-09-09 06:35:46 rhettinger set status: open -> closedresolution: not a bugmessages: + stage: patch review -> resolved
2018-09-09 05:45:27 xtreak set nosy: + xtreakmessages: +
2018-09-09 03:56:11 taketakeyyy@gmail.com set keywords: + patchstage: patch reviewpull_requests: + <pull%5Frequest8573>
2018-09-08 11:03:59 mark.dickinson set nosy: + mark.dickinsonmessages: +
2018-09-08 10:33:56 serhiy.storchaka set assignee: docs@python -> rhettingernosy: + rhettinger
2018-09-08 07:21:56 taketakeyyy@gmail.com create