[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: Just a note, that an (updated) version of the auto-generated API reference has been "officially" added to TkDocs ... see https://tkdocs.com/pyref/ Few more things I'd like to do with it in the short term, but it's a decent starting point. Let me know if you

[issue42560] Improve Tkinter Documentation

E. Paine added the comment: > Thoughts Is it possible to make non-widget specific methods more obvious (the first one that caught my eye was bind_class)? I'm thinking something like using italic with a key at the top noting that is what it means. I like the 'aka' thing, though. Thanks

[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: Would like to throw an idea out for feedback regarding the API reference. I've done some preliminary work auto-generating documentation via widget introspection. It's missing a lot, has many bugs, but is far enough along to give a sense of what this approach

[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: Łukasz, thank you very much for your help with getting these changes merged in! I hope others will chime in with suggestions and/or edits to the newer or substantially revised sections. There is most definitely lots of room for improvement. One specific

[issue42560] Improve Tkinter Documentation

miss-islington added the comment: New changeset e4795103025aeef295a8c5f75cc7c33801f93a24 by Miss Islington (bot) in branch '3.10': bpo-42560: simplify/merge architecture info in Tkinter docs (GH-27839) https://github.com/python/cpython/commit/e4795103025aeef295a8c5f75cc7c33801f93a24

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- pull_requests: +26372 pull_request: https://github.com/python/cpython/pull/27920 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset e41912c6348362489d2514565a70782591f23902 by Mark Roseman in branch 'main': bpo-42560: simplify/merge architecture info in Tkinter docs (GH-27839) https://github.com/python/cpython/commit/e41912c6348362489d2514565a70782591f23902 --

[issue42560] Improve Tkinter Documentation

miss-islington added the comment: New changeset 8351df6e3652a41ffc720066a68b666bbef1df67 by Miss Islington (bot) in branch '3.10': bpo-42560: add warning to Tkinter docs about outdated pre-8.5 documentation online (GH-27836)

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- pull_requests: +26371 pull_request: https://github.com/python/cpython/pull/27915 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset 1eb451031a64b4f28d737ee7f394252ae9a76118 by Mark Roseman in branch 'main': bpo-42560: add warning to Tkinter docs about outdated pre-8.5 documentation online (GH-27836)

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- pull_requests: +26367 pull_request: https://github.com/python/cpython/pull/27911 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- pull_requests: +26368 pull_request: https://github.com/python/cpython/pull/27912 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset 08830a4f75553682e8d1ea6cdabd4c3472c59e28 by Mark Roseman in branch 'main': bpo-42560: rewrite of Tkinter docs "life preserver" (GH-27842) https://github.com/python/cpython/commit/08830a4f75553682e8d1ea6cdabd4c3472c59e28 --

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset 986750be5c7914f4b0120f5627fe848dcced103b by Miss Islington (bot) in branch '3.9': bpo-42560: reorganize Tkinter docs modules section for clarity (GH-27840) (GH-27895)

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset c579f0ba62974b90f348e50088e4c036e281f45e by Łukasz Langa in branch '3.9': [3.9] bpo-42560: rework external references in Tkinter docs (GH-27838) (GH-27896) https://github.com/python/cpython/commit/c579f0ba62974b90f348e50088e4c036e281f45e

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset 8e90f15ac88c66ddb7b084bb5780a126d35168af by Łukasz Langa in branch '3.10': [3.10] bpo-42560: rework external references in Tkinter docs (GH-27838) (GH-27893) https://github.com/python/cpython/commit/8e90f15ac88c66ddb7b084bb5780a126d35168af

[issue42560] Improve Tkinter Documentation

miss-islington added the comment: New changeset 4d1e74f352d8bf70b726b373e19fd21274899d8e by Miss Islington (bot) in branch '3.10': bpo-42560: reorganize Tkinter docs modules section for clarity (GH-27840) https://github.com/python/cpython/commit/4d1e74f352d8bf70b726b373e19fd21274899d8e

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset e74cf8667d7d73e6cacd5d0aedcecbd20e711d6a by Miss Islington (bot) in branch '3.9': bpo-42560: tweaks to intro of Tkinter docs- add macOS, drop ActiveState (GH-27835) (GH-27892)

[issue42560] Improve Tkinter Documentation

miss-islington added the comment: New changeset 61ecd3e593e05c3d84adf5640458a01f8550aa74 by Miss Islington (bot) in branch '3.10': bpo-42560: tweaks to intro of Tkinter docs- add macOS, drop ActiveState (GH-27835)

[issue42560] Improve Tkinter Documentation

Change by Łukasz Langa : -- pull_requests: +26351 pull_request: https://github.com/python/cpython/pull/27896 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- pull_requests: +26349 pull_request: https://github.com/python/cpython/pull/27894 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset d5dbe8bca792350f4997c027535e0ca498abd1bb by Mark Roseman in branch 'main': bpo-42560: reorganize Tkinter docs modules section for clarity (GH-27840) https://github.com/python/cpython/commit/d5dbe8bca792350f4997c027535e0ca498abd1bb --

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- pull_requests: +26350 pull_request: https://github.com/python/cpython/pull/27895 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by Łukasz Langa : -- pull_requests: +26348 pull_request: https://github.com/python/cpython/pull/27893 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- pull_requests: +26347 pull_request: https://github.com/python/cpython/pull/27892 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by miss-islington : -- nosy: +miss-islington nosy_count: 12.0 -> 13.0 pull_requests: +26346 pull_request: https://github.com/python/cpython/pull/27891 ___ Python tracker

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset 141c7a4fce8def67baa9d24f542c105b8502893e by Mark Roseman in branch 'main': bpo-42560: tweaks to intro of Tkinter docs- add macOS, drop ActiveState (GH-27835) https://github.com/python/cpython/commit/141c7a4fce8def67baa9d24f542c105b8502893e

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: New changeset d1049d1d6b43296d4db1aa8668aa4ca807bf7adb by Mark Roseman in branch 'main': bpo-42560: rework external references in Tkinter docs (GH-27838) https://github.com/python/cpython/commit/d1049d1d6b43296d4db1aa8668aa4ca807bf7adb --

[issue42560] Improve Tkinter Documentation

Change by Mark Roseman : -- pull_requests: +26306 pull_request: https://github.com/python/cpython/pull/27842 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by Mark Roseman : -- pull_requests: +26304 pull_request: https://github.com/python/cpython/pull/27840 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by Mark Roseman : -- pull_requests: +26303 pull_request: https://github.com/python/cpython/pull/27839 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by Mark Roseman : -- pull_requests: +26302 pull_request: https://github.com/python/cpython/pull/27838 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by Mark Roseman : -- pull_requests: +26300 pull_request: https://github.com/python/cpython/pull/27836 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

Change by Mark Roseman : -- pull_requests: +26299 pull_request: https://github.com/python/cpython/pull/27835 ___ Python tracker ___

[issue42560] Improve Tkinter Documentation

E. Paine added the comment: > In particular, you added OS-specific info I also deemed this very useful information. The issue is that it is not documented in the man pages and so those values are pulled straight from the source code. We would need to decide whether we keep such information

[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: Łukasz, I've got a bunch of individual branches for each of those sections. What I posted the link to was a merge of all of them just for overview purposes, but the PR's will be created from the individual branches. I can start creating those now or wait a

[issue42560] Improve Tkinter Documentation

Change by Richard Sheridan : -- nosy: +Richard Sheridan ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue42560] Improve Tkinter Documentation

Łukasz Langa added the comment: Mark, it's great to see you work on the documentation again. I would like you invite you to produce a number of smaller PRs, just like you did with GH-27717. Those tend to be much easier to include even as we are discussing larger-scale evolution of the

[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: I would most definitely echo the concern about the massive size of such a project as well as future maintainability. I don't know anyone who would be able to do such a thing on a volunteer basis, and I think it would be highly unlikely that anyone would step

[issue42560] Improve Tkinter Documentation

Terry J. Reedy added the comment: It seems premature to worry about 8.7.0, as it might still be years away. 8.7.0a1 was 4 years ago. 8.6.0 spent 5 years in beta. https://sourceforge.net/projects/tcl/files/Tcl/. I'd like to see improved tkinter docs within a year. I don't think that

[issue42560] Improve Tkinter Documentation

E. Paine added the comment: > I don't see the tcl/tk versions as an issue My main concern was when Tcl/Tk has a major new release with new kwargs. If MacOS was shipped with one version and Windows another, I suspect we would have to hold back an update to the docs. I am slightly less

[issue42560] Improve Tkinter Documentation

Terry J. Reedy added the comment: > Anyone have any big picture thoughts at this point? Yes. For years, I have wanted major changes in out tkinter docs, but making them myself has never become a top priority for me over working directly on IDLE. The latter has been hampered by the

[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: Here's a very rough work-in-progress snapshot: https://github.com/roseman/cpython/blob/tkinter-docs-snapshot-20210815/Doc/library/tkinter.rst This includes: 1. Changes I'd mentioned to the intro, external resources, modules, architecture 2. Rewrite of the

[issue42560] Improve Tkinter Documentation

E. Paine added the comment: Thank you for looking at this in great detail Mark and that all seems like a very useful set of changes! I've got a few more specific comments below, but they're mostly just small details. 2. I'd personally prefer alphabetical order (except Tix, which should be

[issue42560] Improve Tkinter Documentation

Mason Ginter added the comment: Those changes sound great to me, Mark. I've been busy with work and don't think I'll have the time to implement those changes. If you or someone else would like to work on this, I would gladly let you take over. --

[issue42560] Improve Tkinter Documentation

Change by Simão Afonso : -- nosy: +simao.afonso ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue42560] Improve Tkinter Documentation

Change by Mark Roseman : -- nosy: +lukasz.langa, terry.reedy ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: Here are my broad suggestions for improvement (each of these would turn into a separate PR). Thoughts for/against each? 1. 'See also' section: use this to guide people to what they need. update to point out challenge of finding material given age etc.,

[issue42560] Improve Tkinter Documentation

Mark Roseman added the comment: I was having a peek at the main tkinter doc page again and would like to take a broader crack at it. I think most of what is there now (life preserver/reference) needs to be substantially reworked or trimmed. I think exhaustive description of all methods etc.

[issue42560] Improve Tkinter Documentation

FredInChina added the comment: Ah, I understand now, thank you for the clear explanation @epaine, appreciated. Thanks also for the link to Pr. Shipman's docs mirror on tkdocs. It is not my place to argue what to do in such a case, but please allow me to re-emphasize the need for better

[issue42560] Improve Tkinter Documentation

E. Paine added the comment: > shouldn't the docs be made available for the currently maintained version of > python? Problem is the Tk version (which underpins tkinter) varies by distribution. Currently, Windows and MacOS Intel installers are packaged with 8.6.8, while MacOS Universal2 is

[issue42560] Improve Tkinter Documentation

FredInChina added the comment: I agree with @MasonGinter, the documentation is somewhat lacking. Relying on third parties is fragile - we were fortunate that the University of New Mexico Tech docs maintained by Pr. John W. Shipman were

[issue42560] Improve Tkinter Documentation

E. Paine added the comment: @Fredrik, can you comment on when we might expect effbot.org to become available again? (i.e. is it worth us updating the docs to note that its down / changing the link to the Wayback Machine?) -- nosy: +effbot ___

[issue42560] Improve Tkinter Documentation

Mason Ginter added the comment: Would it then be a good idea to add a link to the archive.org version of effbot? If so how best to add it to the documentation. The only other instances I can find links to archive.org in the documentation reference webpages that are down permanently, unlike

[issue42560] Improve Tkinter Documentation

E. Paine added the comment: See issue34154. I'm personally against such changes because we don't know what Tk version to write them for. Our documentation could be both outdated and too recent, including kwargs not available to some people (because they are running an older version). The

[issue42560] Improve Tkinter Documentation

Change by Roundup Robot : -- keywords: +patch nosy: +python-dev nosy_count: 2.0 -> 3.0 pull_requests: +22557 stage: -> patch review pull_request: https://github.com/python/cpython/pull/23689 ___ Python tracker

[issue42560] Improve Tkinter Documentation

New submission from Mason Ginter : Online python Tkinter documentation (https://docs.python.org/3/library/tkinter.html) lacks many features. The main part I find lacking is documentation on methods, as many of them either aren't listed in the documentation and/or take *args as the only