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.

Title: Docstrings in itertools recipes should have triple-quotes
Type: Stage: resolved
Components: Versions: Python 3.10, Python 3.9, Python 3.8, Python 3.7, Python 3.6
Status: closed Resolution: not a bug
Dependencies: Superseder:
Assigned To: Nosy List: eric.smith, miss-islington, peter.norvig2, rhettinger
Priority: normal Keywords:

Created on 2020-11-24 01:54 by peter.norvig2, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 23555 merged rhettinger, 2020-11-29 12:04
PR 23562 merged miss-islington, 2020-11-29 18:47
Messages (7)
msg381704 - (view) Author: Peter Norvig (peter.norvig2) Date: 2020-11-24 01:54
In the itertools recipes ( ) there are 21 functions that have single-quote docstrings. These should be changed to triple-quotes, as mandated in PEP 257.
msg381705 - (view) Author: Eric V. Smith (eric.smith) * (Python committer) Date: 2020-11-24 01:57
I don't think the readability of the examples would be improved by triple quotes. In fact, I think it would be reduced.
msg381706 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-11-24 02:25
I concur with Eric.
msg381831 - (view) Author: Eric V. Smith (eric.smith) * (Python committer) Date: 2020-11-25 14:02
Although I do have to say it wouldn't offend me if the partition and nth_combination examples were changed to double quotes to be consistent! But it's not important.
msg381875 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-11-26 05:36
Thanks Eric, I will update those quotation marks in the next edit to the recipes.

Peter, sorry I closed this so abruptly.  All suggestions are welcome.  In this case, readability trumps other rules.  Also, PEP 257 wasn't intended to be strict.  Lots of code in the standard library follows local conventions which vary module to module.
msg382087 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-11-29 18:47
New changeset fc40b3020cf3c869833fd5d3720cf9768fe3bb46 by Raymond Hettinger in branch 'master':
bpo-42450: Minor updates to the itertools recipes (GH-23555)
msg382090 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-11-29 19:14
New changeset a83119d7be95dd3f5ff22abe289da6091584f853 by Miss Islington (bot) in branch '3.9':
bpo-42450: Minor updates to the itertools recipes (GH-23555) (GH-23562)
Date User Action Args
2022-04-11 14:59:38adminsetgithub: 86616
2020-11-29 19:14:13rhettingersetmessages: + msg382090
2020-11-29 18:47:37miss-islingtonsetnosy: + miss-islington

pull_requests: + pull_request22443
2020-11-29 18:47:30rhettingersetmessages: + msg382087
2020-11-29 12:04:03rhettingersetpull_requests: + pull_request22436
2020-11-26 05:36:08rhettingersetmessages: + msg381875
2020-11-25 14:02:32eric.smithsetmessages: + msg381831
2020-11-24 04:20:17rhettingersetstatus: open -> closed
resolution: not a bug
stage: resolved
2020-11-24 02:25:51rhettingersetmessages: + msg381706
2020-11-24 02:16:39xtreaksetnosy: + rhettinger
2020-11-24 01:57:01eric.smithsetnosy: + eric.smith
messages: + msg381705
2020-11-24 01:54:26peter.norvig2create