bpo-33280: Update link to Tcl/Tk 8.6 man pages #6473

andresdelfino · 2018-04-14T20:13:56Z

https://bugs.python.org/issue33280

serhiy-storchaka · 2018-04-22T19:28:50Z

Doc/library/tkinter.rst

+   `Practical Programming in Tcl and Tk <http://www.beedub.com/book/>`_
+      Brent Welch's encyclopedic book.
+
+   `TKDocs <http://www.tkdocs.com/>`_


This is about Tkinter, not just Tcl/Tk.

You mean it's better to show all links together?

I mean that these two links are in wrong section.

I can see how TKDocs talks about Tkinter, but does "Practical Programming in Tcl and Tk" talk about Tkinter too?

The Welch's excellent book is about Tcl/Tk. The Lutz's book is about Python and Tkinter in particular.

I can see how TKDocs talks about Tkinter (moved the link on the last update of the PR), but can0t see how "Practical Programming in Tcl and Tk" talks about Tkinter. Is that the case or am I not getting you?

serhiy-storchaka · 2018-04-22T19:29:17Z

Doc/library/tkinter.rst

+   `TKDocs <http://www.tkdocs.com/>`_
+      Extensive tutorial plus friendlier widget pages for some of the widgets.
+
+   `Programming Python <http://learning-python.com/about-pp4e.html>`_


This is not Tcl/Tk documentation.

Sorry, it slipped.

serhiy-storchaka

Some links was reordered in the first section. "Programming Python" and "TKDocs" was moved to the end. Is this for purpose?

andresdelfino · 2018-04-22T21:44:15Z

@serhiy-storchaka Sorry, no, the change of the order was unintentional. I have reverted it in the last commit.

terryjreedy

I tested the new link and it does not do the job needed. It goes to the wrong place for tkinter users looking for documentation of tk/tkinter widgets. The same was true for the two links replaced. They required just one click instead of two to get to the right place, but had disadvantages, so the new link should be kept, but as a secondary addition.

Since there is no generic 8.x Tk commands (widgets) page, the best we can do for tk widget docs is to link the most likely 8.x page (8.6 for now), and tell users to change '6' for the corresponding page for other tk versions. I use this page constantly along with the NMT 8.5 tkinter reference.

terryjreedy · 2018-04-23T00:50:27Z

Doc/library/tkinter.rst

+Running ``python -m tkinter`` from the command line should open a window
+demonstrating a simple Tk interface, letting you know that :mod:`tkinter` is
+properly installed on your system, and also showing what version of Tcl/Tk is
+installed, so you can read the Tcl/Tk documentation specific to that version.


Separate paragraph is improvement.

terryjreedy · 2018-04-23T01:02:46Z

Doc/library/tkinter.rst


 .. seealso::

+   Tkinter documentation:
+


I like the separate paragraph for testing, and the separation of tkinter versus tk docs. Some of the descriptions could be updated, but lets make that a separate issue.

terryjreedy · 2018-04-23T01:33:41Z

Doc/library/tkinter.rst

+   Tcl/Tk documentation:
+
+   `Tcl/Tk recent man pages <https://www.tcl.tk/doc/>`_
+      Recent Tcl/Tk manuals on www.tcl.tk.


This is the heart of the issue. I see two deficiencies wtih the link above.

This link has quick links to 8.6 and 8.7 but not 8.5.

Each link goes to an general tcl/tk index page for 8.x with 16 entries. One has to know to then click the following, which will not be obvious to everyone.

Tk Commands The additional commands which the wish interpreter implements.

I was initially confused because I did not know until now that there are two tcl shell/interpreters and that tkinter is implementing the wish add-ons, and not core tcl/tk, or perhaps the following.

Tk Library The additional C functions which a Tk extended C program may use.

So I strongly suggest adding at the top what 99% of users of this section need to read.

Tk commands <https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm> Commands without '__' in their name correspond to tkinter and ttk widget classes. Change '6' to '4', '5', or '7' for the corresponding tk/tkinter versions.

I agree. Since we are bundling 8.6 it does make sense to make it the default link, while pointing out how to get to the other versions too.

Oh, I missed that @andresdelfino moved one level up. The link to the default Tcl/Tk manual is https://www.tcl.tk/man/tcl/.

I think this link is for more advanced users, and for beginners the link to effbot.org and similar resources is more preferable. Maybe we should copy the content from external resources.

If you are saying that our doc should include a tk widget reference, I agree. Another issue.

bedevere-bot · 2018-04-23T01:54:03Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

andresdelfino · 2018-04-23T02:24:16Z

I have made the requested changes; please review again

bedevere-bot · 2018-04-23T02:24:18Z

Thanks for making the requested changes!

@terryjreedy, @serhiy-storchaka: please review the changes made to this pull request.

bedevere-bot · 2018-04-23T09:09:20Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

andresdelfino · 2018-04-23T12:42:43Z

I didn't expect the Spanish Inquisition :)

bedevere-bot · 2018-04-23T12:42:45Z

Nobody expects the Spanish Inquisition!

@terryjreedy, @serhiy-storchaka: please review the changes made to this pull request.

andresdelfino · 2018-04-23T21:40:30Z

Sorry, I followed bedevere's instructions because I didn't see @terryjreedy approval.

miss-islington · 2018-04-25T17:54:01Z

Thanks @andresdelfino for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6, 3.7.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington · 2018-04-25T17:55:33Z

Sorry, @andresdelfino and @serhiy-storchaka, I could not cleanly backport this to 3.6 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 67a8f4fed3169e1b8c947c10f6e06863e399ae32 3.6

(cherry picked from commit 67a8f4f) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>

bedevere-bot · 2018-04-25T17:56:38Z

GH-6600 is a backport of this pull request to the 3.7 branch.

miss-islington · 2018-04-25T17:57:34Z

Sorry, @andresdelfino and @serhiy-storchaka, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 67a8f4fed3169e1b8c947c10f6e06863e399ae32 2.7

bedevere-bot · 2018-04-25T18:29:08Z

GH-6602 is a backport of this pull request to the 3.6 branch.

(cherry picked from commit 67a8f4f) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>

bedevere-bot · 2018-04-25T18:40:00Z

GH-6603 is a backport of this pull request to the 2.7 branch.

andresdelfino · 2018-04-25T21:18:01Z

GH-6607 is a backport of this pull request to the 2.7 branch.

…H-6607) (cherry picked from commit 67a8f4f) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>

…6602) (cherry picked from commit 67a8f4f) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>

the-knights-who-say-ni added the CLA signed label Apr 14, 2018

bedevere-bot added the awaiting review label Apr 14, 2018

andresdelfino added 3 commits April 14, 2018 22:33

Link to Tcl/Tk 8.5 -> 8.6

7f7faa6

Update manuals link and reorganize external references

15e8084

Add version comment about -m tkinter

e030ea5

serhiy-storchaka added needs backport to 3.6 docs Documentation in the Doc dir skip news labels Apr 22, 2018

serhiy-storchaka reviewed Apr 22, 2018

View reviewed changes

Move links to correct section

8e553a0

serhiy-storchaka reviewed Apr 22, 2018

View reviewed changes

Undo unintentional sorting change

5431340

serhiy-storchaka approved these changes Apr 22, 2018

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Apr 22, 2018

serhiy-storchaka requested a review from terryjreedy April 22, 2018 21:51

terryjreedy requested changes Apr 23, 2018

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting merge labels Apr 23, 2018

Add link to Tk commands at the top of the list

f588afd

bedevere-bot removed the awaiting changes label Apr 23, 2018

bedevere-bot added the awaiting change review label Apr 23, 2018

terryjreedy approved these changes Apr 23, 2018

View reviewed changes

bedevere-bot removed the awaiting change review label Apr 23, 2018

bedevere-bot removed the awaiting merge label Apr 23, 2018

bedevere-bot added the awaiting changes label Apr 23, 2018

Move Tk commands link, and update comment

b0e0abd

terryjreedy approved these changes Apr 23, 2018

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Apr 23, 2018

serhiy-storchaka approved these changes Apr 23, 2018

View reviewed changes

bedevere-bot added awaiting change review and removed awaiting merge labels Apr 23, 2018

serhiy-storchaka merged commit 67a8f4f into python:master Apr 25, 2018

bedevere-bot removed the awaiting change review label Apr 25, 2018

bedevere-bot removed the needs backport to 3.7 label Apr 25, 2018

bedevere-bot removed the needs backport to 3.6 label Apr 25, 2018

miss-islington added a commit that referenced this pull request Apr 25, 2018

bpo-33280: Reorganize external Tcl/Tk references. (GH-6473)

53d36cc

(cherry picked from commit 67a8f4f) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>

bedevere-bot removed the needs backport to 2.7 label Apr 25, 2018

andresdelfino deleted the tcltkversion branch April 25, 2018 18:43

serhiy-storchaka pushed a commit that referenced this pull request Apr 26, 2018

[2.7] bpo-33280: Reorganize external Tcl/Tk references. (GH-6473). (G…

1c6c851

…H-6607) (cherry picked from commit 67a8f4f) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>

serhiy-storchaka pushed a commit that referenced this pull request Apr 26, 2018

[3.6] bpo-33280: Reorganize external Tcl/Tk references. (GH-6473). (#…

4533494

…6602) (cherry picked from commit 67a8f4f) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-33280: Update link to Tcl/Tk 8.6 man pages #6473

bpo-33280: Update link to Tcl/Tk 8.6 man pages #6473

andresdelfino commented Apr 14, 2018 •

edited by bedevere-bot

serhiy-storchaka Apr 22, 2018

andresdelfino Apr 22, 2018

serhiy-storchaka Apr 22, 2018

andresdelfino Apr 22, 2018

serhiy-storchaka Apr 22, 2018

andresdelfino Apr 22, 2018

serhiy-storchaka Apr 22, 2018

andresdelfino Apr 22, 2018

serhiy-storchaka left a comment

andresdelfino commented Apr 22, 2018

terryjreedy left a comment •

edited

terryjreedy Apr 23, 2018

terryjreedy Apr 23, 2018

terryjreedy Apr 23, 2018

andresdelfino Apr 23, 2018

serhiy-storchaka Apr 23, 2018

terryjreedy Apr 23, 2018

bedevere-bot commented Apr 23, 2018

andresdelfino commented Apr 23, 2018

bedevere-bot commented Apr 23, 2018

bedevere-bot commented Apr 23, 2018

andresdelfino commented Apr 23, 2018

bedevere-bot commented Apr 23, 2018

andresdelfino commented Apr 23, 2018 •

edited

miss-islington commented Apr 25, 2018

miss-islington commented Apr 25, 2018

bedevere-bot commented Apr 25, 2018

miss-islington commented Apr 25, 2018

bedevere-bot commented Apr 25, 2018

bedevere-bot commented Apr 25, 2018

andresdelfino commented Apr 25, 2018

bpo-33280: Update link to Tcl/Tk 8.6 man pages #6473

bpo-33280: Update link to Tcl/Tk 8.6 man pages #6473

Conversation

andresdelfino commented Apr 14, 2018 • edited by bedevere-bot

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

serhiy-storchaka left a comment

Choose a reason for hiding this comment

andresdelfino commented Apr 22, 2018

terryjreedy left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bedevere-bot commented Apr 23, 2018

andresdelfino commented Apr 23, 2018

bedevere-bot commented Apr 23, 2018

bedevere-bot commented Apr 23, 2018

andresdelfino commented Apr 23, 2018

bedevere-bot commented Apr 23, 2018

andresdelfino commented Apr 23, 2018 • edited

miss-islington commented Apr 25, 2018

miss-islington commented Apr 25, 2018

bedevere-bot commented Apr 25, 2018

miss-islington commented Apr 25, 2018

bedevere-bot commented Apr 25, 2018

bedevere-bot commented Apr 25, 2018

andresdelfino commented Apr 25, 2018

andresdelfino commented Apr 14, 2018 •

edited by bedevere-bot

terryjreedy left a comment •

edited

andresdelfino commented Apr 23, 2018 •

edited