[issue34839] doctest: Change example under warnings section

miss-islington added the comment: New changeset a910c2c6f3542b61f084de2ece0d8dab09c5a0fa by Miss Islington (bot) in branch '3.7': bpo-34839: Add a 'before 3.6' in the section 'warnings' of doctest (GH-9736) https://github.com/python/cpython/commit/a910c2c6f3542b61f084de2ece0d8dab09c5a0fa --

[issue34839] doctest: Change example under warnings section

Change by miss-islington : -- pull_requests: +12720 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: https://m

[issue34839] doctest: Change example under warnings section

Change by Julien Palard : -- resolution: -> fixed stage: needs patch -> resolved status: open -> closed ___ Python tracker ___ ___

[issue34839] doctest: Change example under warnings section

Julien Palard added the comment: New changeset 0522fd81dc6e3482c2d4c8719f1f85ad5924eede by Julien Palard (Stéphane Wirtel) in branch 'master': bpo-34839: Add a 'before 3.6' in the section 'warnings' of doctest (GH-9736) https://github.com/python/cpython/commit/0522fd81dc6e3482c2d4c8719f1f85ad5

[issue34839] doctest: Change example under warnings section

Stéphane Wirtel added the comment: Hi Raymond and Tim, I just updated the PR with your recommendations. Have a nice day, -- ___ Python tracker ___ ___

[issue34839] doctest: Change example under warnings section

Stéphane Wirtel added the comment: Tim, I understand. It's just my experience, I have seen a lot of new comers (in my python trainings), they just copy the examples and don't read the total explanation. sometimes, because english is not their native language and in this case, they try to fin

[issue34839] doctest: Change example under warnings section

Tim Peters added the comment: Stephane, it's not deep. People who need to write doctests that work across N versions of Python shouldn't need to read N versions of the documentation. This is hardly unique to doctest. We routinely add "Changed in version m.n" blurbs all over the place. Wa

[issue34839] doctest: Change example under warnings section

Stéphane Wirtel added the comment: Hi Raymond, Ok, if you agree with Tim, I just created a PR. Have a nice day, -- keywords: -patch stage: patch review -> needs patch ___ Python tracker __

[issue34839] doctest: Change example under warnings section

Change by Stéphane Wirtel : -- keywords: +patch pull_requests: +9123 stage: needs patch -> patch review ___ Python tracker ___ ___ Py

[issue34839] doctest: Change example under warnings section

Raymond Hettinger added the comment: FWIW, set objects are still unordered, so they too require sorting for a reproducible doctest. -- ___ Python tracker ___

[issue34839] doctest: Change example under warnings section

Raymond Hettinger added the comment: > Raymond, what do you think? I concur with Tim. -- ___ Python tracker ___ ___ Python-bugs-li

[issue34839] doctest: Change example under warnings section

Stéphane Wirtel added the comment: Hi Terry, You say we need to keep this illustration with a section 'before 3.6' but in think it's a bad thing. 1. when you read a documentation, you just copy the example, and sometimes you don't read the requirements. 2. why do we need to keep an illustrat

[issue34839] doctest: Change example under warnings section

Lysandros Nikolaou added the comment: I would be happy to change this. I will submit a PR ASAP. -- nosy: +lys.nikolaou ___ Python tracker ___ _

[issue34839] doctest: Change example under warnings section

Terry J. Reedy added the comment: I am posting this on core-mentorship. If you want to do this, post here and submit the PR within a day. I will do the merge is no-one else does. -- versions: +Python 3.7 ___ Python tracker

[issue34839] doctest: Change example under warnings section

Cheryl Sabella added the comment: Thanks for the discussion. I'll mark this as 'easy' for a first-time contribution. -- keywords: +easy stage: -> needs patch ___ Python tracker ___

[issue34839] doctest: Change example under warnings section

Tim Peters added the comment: Add a comment along the lines you (Terry) suggested. Some people need to write doctests that run under many versions of Python, so the info is still supremely relevant to them. -- nosy: +tim.peters ___ Python tracker

[issue34839] doctest: Change example under warnings section

Terry J. Reedy added the comment: To me, the question is whether to delete the dict example, or qualify it with "Before 3.7 (or 3.6 for CPython)" but leave the illustration of workarounds. Raymond, what do you thing? -- nosy: +rhettinger, terry.reedy

[issue34839] doctest: Change example under warnings section

New submission from Cheryl Sabella : The Warnings section of the doctest documentation (https://docs.python.org/3.8/library/doctest.html#warnings) contains an example that the printing order of a dictionary is not guaranteed. Since it is now guaranteed to be insertion order, perhaps the exam