python
Issues from [email protected]
Users who don't have a github login are instructed to report issues to [email protected]. I meant to do some triaging before converting the mails to GH issues, but always had something more important to do. So I'm posting a rough list to get more eyes on these. Each has a link to the list post.
### Tasks
- [x] typo in socket docs -- [Hank Knox](https://mail.python.org/archives/list/[email protected]/thread/T7BAG3ROH3YT3YTAWCUE7CMZ2FI6VO72/)
- [x] asyncio shield typo -- [Dyussenov Nuraly](https://mail.python.org/archives/list/[email protected]/thread/6EM4DHHS3RMWSJWV2ZGKWTJRD4Z2GNIC/) - (https://github.com/python/cpython/pull/108427)
- [ ] array -- data type range printed wrong -- [Shivansh Verma](https://mail.python.org/archives/list/[email protected]/thread/B463UYLY2RBIG66LXM3TIPZDZIYWCN6X/) (#113708)
- [ ] EPUB error -- e.g. [Glenn Street](https://mail.python.org/archives/list/[email protected]/thread/HSIILYH7LVK4JU5U5GWHHIP4PU34UTNN/), [Ranjith B](https://mail.python.org/archives/list/[email protected]/thread/Y3K22WC7QQVIECZBLFZPYYFWOCAOPZ2K/), [sobi](https://mail.python.org/archives/list/[email protected]/message/JELSGFZ6HC2SKHPHTX3LSGH627QVGE5N/)
- [x] Howto/regex omits the simplest {n} case -- [Derek Mead](https://mail.python.org/archives/list/[email protected]/thread/7D56UZ3VSWCQVQPIL44LWTO42EJUBRKI/) -- (https://github.com/python/cpython/pull/111110)
- [ ] Problem in help for str().rsplit() -- [Alan Brogan](https://mail.python.org/archives/list/[email protected]/thread/MCSKKTHBKX6AIK25YI2INEDVONJZYRLH/) - (https://github.com/python/cpython/pull/113355)
- [ ] replacement for deprecation -- [SUN Guonian](https://mail.python.org/archives/list/[email protected]/thread/4AYZNSW3RB3DNT5C7JEE6RCESBWIKZTD/) (https://github.com/python/cpython/pull/112783)
- [x] Potential typo in Profiler docs? -- [2dfkit](https://mail.python.org/archives/list/[email protected]/thread/DJNXVVP2UW4R6OAPRA6TE5WMHDC4NKZ6/)
- [x] timeit -- [Arthur Goldberg](https://mail.python.org/archives/list/[email protected]/thread/CQON3MGDEN6CY5KFXXBY4FTCG2FIIDTM/) -- (GH-110407)
- [x] list of errata: 1 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/)
- [ ] list of errata: 2 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/)
- [x] list of errata: 3 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/) -- (https://github.com/python/cpython/pull/112777)
- [ ] list of errata: 4 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/)
- [ ] list of errata: 5 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/)
- [ ] list of errata: 6 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/)
- [x] list of errata: 7 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/)
- [x] list of errata: 8 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/) -- (https://github.com/python/cpython/pull/111574)
- [x] list of errata: 9 -- [Stephan Stiller](https://mail.python.org/archives/list/[email protected]/thread/ZEDPZHRVGLYR4ZFZ5I3NBWVMHMX4WPGW/)
- [x] profiler docs inaccuracy -- [2dfkit](https://mail.python.org/archives/list/[email protected]/thread/DJNXVVP2UW4R6OAPRA6TE5WMHDC4NKZ6/#DJNXVVP2UW4R6OAPRA6TE5WMHDC4NKZ6) -- (https://github.com/python/cpython/pull/112221)
- [ ] https://github.com/python/cpython/issues/112146
- [ ] Getting tkinter -- [Steve Philcox](https://mail.python.org/archives/list/[email protected]/message/JOQ3RQVG3A7ZYOWEVU7TAYLY2WSZ6TST/)
- [ ] PDF readability concerns -- [Muskula Rahul](https://mail.python.org/archives/list/[email protected]/message/ER3QIEGI63L4C4N2Q5I6GJHBYU5UZGG7/)
- [ ] Problems in Python tutorial -- [Todd Hoatson](https://mail.python.org/archives/list/[email protected]/message/REO4QRDIHU5ML4BMNXPDONCKONIH6RN3/)
- [ ] link from UserList docs to the collections classes list of methods -- [Seebs](https://mail.python.org/archives/list/[email protected]/message/37ZRBCHCB37Y2KW73EBHXFGRIZHFCNUU/)
- [ ] confusing formatting of “`field`s” -- [Роман Филимонов](https://mail.python.org/archives/list/[email protected]/message/G5AYM2N4LLB65BTPQZBX5BIMBXRGUPVP/)
- [ ] socket.makefile -- [Michael Gold](https://mail.python.org/archives/list/[email protected]/thread/3VGLA6Q6QDYB7XIAHFIRAVW4TQSEAZGA/)
- [ ] `pow` - “integral” is confusing to non-natives -- [marc rovira](https://mail.python.org/archives/list/[email protected]/thread/HD47WPHMLKUTQEWEQOHBAGULUHN4ICPQ/)
Feel free to tick off ones that aren't appropriate, and convert larger ones to their own issues.
Linked PRs
- gh-110407
- gh-110409
- gh-110410
- gh-110434
- gh-110435
- gh-110436
- gh-111018
- gh-111110
- gh-111204
- gh-111205
- gh-111206
- gh-111207
- gh-111208
- gh-111247
- gh-112221
- gh-112262
- gh-112263
- gh-111574
- gh-112264
- gh-112265
- gh-112777
- gh-112783
- gh-113353
- gh-113355
- gh-113379
- gh-113380
- gh-113708
- gh-118970
- gh-119150
- gh-119230
Asyncio shield typo - solved. Problem in help for str().rsplit() - solved. list of errata: 9 - solved. list of errata: 8- solved. list of errata: 7 - solved. list of errata: 2 - solved.
These tasks has been solved @hugovk. Some changes has not yet reflected on the Doc page.
Thanks for checking!
Asyncio shield typo - solved.
This was fixed in https://github.com/python/cpython/pull/108427 but not backported. I'm backporting now: https://github.com/python/cpython/pull/111244, https://github.com/python/cpython/pull/111245.
Problem in help for str().rsplit() - solved.
This still exists, it's in the docstring: https://github.com/search?q=repo%3Apython%2Fcpython%20%22starting%20from%20the%20left%22&type=code
list of errata: 9 - solved.
Fixed in https://github.com/python/cpython/pull/107386.
list of errata: 8- solved.
Still present.
list of errata: 7 - solved.
I don't see the reported problem -- buffering=- 1 -- nor the suggested solution -- buffering= -1. Instead I see buffering=-1 which looks correct. Perhaps the problem is only on a certain browser? I'm using Chrome on macOS. Anyway, let's mark as solved.
list of errata: 2 - solved.
Not solved, but they're suggesting replacing get(key[, default]) with get(key[, default=None]).
We've had discussions around this sort of thing, and I'm not sure about this one.
Problem in help for str().rsplit() - solved.
This still exists, it's in the docstring: https://github.com/search?q=repo%3Apython%2Fcpython%20%22starting%20from%20the%20left%22&type=code
I have fixed it now, now this is the pull request - (https://github.com/python/cpython/pull/111247#ref-issue-1927870489). Help check. Also to note, I changed the 'left' to 'right' for the str.rpslit Doc only. The str.split should start from the left.
list of errata: 9 - solved.
Fixed in #107386.
list of errata: 8- solved.
Still present.
list of errata: 7 - solved.
I don't see the reported problem --
buffering=- 1-- nor the suggested solution --buffering= -1. Instead I seebuffering=-1which looks correct. Perhaps the problem is only on a certain browser? I'm using Chrome on macOS. Anyway, let's mark as solved.list of errata: 2 - solved.
Not solved, but they're suggesting replacing
get(key[, default])withget(key[, default=None]).We've had discussions around this sort of thing, and I'm not sure about this one.
Ohh, yeah, the reported problem was present on my Linux machine with Chrome browser, but, it isbuffering=-1 in the repo which is correct.
list of errata: 7 - solved.
I don't see the reported problem --
buffering=- 1-- nor the suggested solution --buffering= -1. Instead I seebuffering=-1which looks correct. Perhaps the problem is only on a certain browser? I'm using Chrome on macOS. Anyway, let's mark as solved.
It is (was) a theme issue: see #96056, #98444.
Thanks for checking!
Asyncio shield typo - solved.
This was fixed in #108427 but not backported. I'm backporting now: #111244, #111245.
This was also reverted in GH-111271 and friends :). I've opened gh-111274 to deal with this one on its own.
Thanks!
I've marked both of these as done because I think they're the same thing. Let me know if not.
- [x] Potential typo in Profiler docs? -- 2dfkit
- [x] profiler docs inaccuracy -- 2dfkit -- (https://github.com/python/cpython/pull/112221)
Hi @hugovk help review this https://github.com/python/cpython/pull/111574
list of errata: 1 -- Stephan Stiller
This is:
https://docs.python.org/3/tutorial/controlflow.html I think it would be better if there were a pastable space after "144 233 377 610 987 1597" (and in some other places in the tutorial). My guess is that the present formatting has to do with the way these pages are generated.
I don't think there's anything actionable here, I'll check it off the list.
- socket.makefile -- Michael Gold
Further documented that combined file modes are supported. https://github.com/python/cpython/pull/119150
Hey y'all, first time contributor here. I've opened PR #119330 for "list of errata: 2".
Hello, I've submitted a pull request addressing two of the issues mentioned earlier. Please feel free to review it at your convenience and let me know if there are any adjustments you'd like me to make.
Regarding the PDF readability issue:
[...] I appreciate the wealth of information in the Python documentation but have encountered challenges with the PDF format. Specifically, the code sample readability is hindered, making it hard to highlight and annotate effectively. Please have a look at the picture attached , you will find the code sample hard to read.
To enhance accessibility, I suggest optimizing code sample color contrast. This improvement would benefit users across preferences and ensure a more user-friendly experience.
The image attached to that report, is attached here:
I downloaded the docs as PDF, and currently they're rendered like this:
IMO, there is an improvement, but I'm not sure if it's a good enough improvement. Comments? It sounds to me this may be better handled as a separate issue.
The 4.43:1 contrast ratio of green digits on grey is much better than before, but doesn't quite meet the WCAG AA guidelines of 4.5:1.
https://webaim.org/resources/contrastchecker/?fcolor=247F51&bcolor=F2F2F2
The grey symbols (5.12:1) meets AA and the black text (18.75:1) meets both AA and AAA (7:1).
I'm not sure where these colours are defined.
I'm not sure where these colours are defined.
Me neither, but ISTM the PDFs are generated from make -C Doc dist. I'm suspecting it might be the Sphinx LaTeX package sphinx.sty.
@encukou: I suggest creating separate, and more actionable, issues of the EPUB and PDF readability reports. I think the two remaining issues reports by Stiller are non-issues; the first is talking about IDLE in a tutorial that is using the REPL, and I'm not sure the remaining issue is worth trying to solve. Regarding the "UserList" issue, I have no opinion.
In the future, I think it would be better to not collect multiple unrelated reports into one issue, like it's done here; such an umbrella issue has an enormous risk of quickly turning stale. IMO, it is better for the reporters, for the triagers, and for contributors, if we break these up into single more actionable and easily triaged issues :)
I suggest creating separate, and more actionable, issues of the EPUB and PDF readability reports.
Please do make an issue! GitHub has a button to do that in the ⋯ menu.
IMO, it is better for the reporters, for the triagers, and for contributors, if we break these up into single more actionable and easily triaged issues
When I did that, I was too tempted to triage each of the reports, which resulted in a big backlog. Converting from email to GitHub needs to take me less than a minute; otherwise, on a busy day I'll leave it to “some day when I have time”.
I think the two remaining issues reports by Stiller are non-issues; the first is talking about IDLE in a tutorial that is using the REPL, and I'm not sure the remaining issue is worth trying to solve.
I've checked these off as WONTFIX.
Regarding the "UserList" issue, I have no opinion.
Same, and no-one else has had a go, so I've checked this off as WONTFIX too.
We've got new issues for some of these things, I think we can close this issue now, thanks everyone for helping out!