Skip to content

bpo-33479: Tkinter docs #7287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
roseman wants to merge 32 commits into from
Closed

bpo-33479: Tkinter docs #7287

Changes from 3 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
79b195a
* Reduce the index page to a summary like the other ones
native-api May 19, 2018
6338ba1
* move seealso to the bottom
native-api May 19, 2018
02f712e
more 0. intro
native-api May 19, 2018
e68e136
https://bugs.python.org/issue33479#msg316492 1. Architecture.
native-api May 19, 2018
1de7f35
1. Architecture -- Tkinter modules
native-api May 20, 2018
6a7f4e8
2. Threading model
native-api May 22, 2018
c8f3bca
start documenting contents
native-api May 24, 2018
6cdcb9e
* queue is per-thread
native-api May 25, 2018
35521e8
update Tcl/Tk resource URLs and verbiage
roseman May 30, 2018
77c674b
small rewording/reorganization of architecture and modules sections
roseman May 30, 2018
61c23d2
rewrite threading model section to separate normal use from potential…
roseman May 30, 2018
5a80739
https://github.com/python/cpython/pull/7287#discussion_r192545213
native-api Jun 3, 2018
77b711e
https://github.com/python/cpython/pull/7287#discussion_r192545445
native-api Jun 3, 2018
9a5b0e8
Merge pull request #1 from native-api/roseman_1
roseman Jun 3, 2018
8bf32fd
Merge pull request #2 from native-api/roseman_2
roseman Jun 3, 2018
c11080d
https://github.com/python/cpython/pull/7287#discussion_r192545697
native-api Jun 3, 2018
d270dab
mention Tix as it adds more complexity to the architecture
native-api Jun 3, 2018
0bd73e2
spec
native-api Jun 3, 2018
e8d124a
https://github.com/python/cpython/pull/7287#discussion_r192545744
native-api Jun 3, 2018
0961c38
https://github.com/python/cpython/pull/7287#discussion_r192545829
native-api Jun 3, 2018
f91ff5d
more specific
native-api Jun 3, 2018
4b9152e
https://github.com/python/cpython/pull/7287#discussion_r192545899
native-api Jun 3, 2018
7281922
https://github.com/python/cpython/pull/7287#discussion_r192545996
native-api Jun 3, 2018
7fdbef3
https://github.com/python/cpython/pull/7287#discussion_r192546347
native-api Jun 3, 2018
4f5218c
plural releases
roseman Jun 3, 2018
b53bab2
Merge pull request #3 from native-api/roseman_3
roseman Jun 3, 2018
89364bb
Merge pull request #4 from native-api/roseman_4
roseman Jun 3, 2018
fbf276f
Merge pull request #5 from native-api/roseman_5
roseman Jun 3, 2018
37ef774
Merge pull request #6 from native-api/roseman_6
roseman Jun 3, 2018
7551744
Merge pull request #7 from native-api/roseman_7
roseman Jun 3, 2018
71a934d
put back 'older' for tix
roseman Jun 3, 2018
eb6623d
Merge pull request #9 from native-api/roseman_9
roseman Jun 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions Doc/library/tkinter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,11 @@ Tcl
interface to the Tk toolkit. The Tcl library has a C interface to
create and manage one or more instances of a Tcl interpreter, run Tcl
commands and scripts in those instances, and add custom commands
implemented in either Tcl or C. Tcl provides for an event queue, used
for I/O, timers, and by modules.
implemented in either Tcl or C. Each interpreter has an event queue,
and there are facilities to send events to it and process them.
Unlike Python, Tcl's execution model is designed around cooperative
multitasking, and Tkinter bridges this difference
(see `Threading model`_ for details).

Tk
Tk is a module that can be loaded into a Tcl interpreter instance. It adds

@native-api native-api Jun 2, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vague, omits that it's a Tcl module and adds custom Tcl commands -- those very ones that were mentioned in the prev. paragraph. This text fails to make that connection.

@roseman roseman Jun 2, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree. Thanks.

Question: Tcl uses the term "package" for what Python calls a module. Would it be better to say up front something to the effect of "the tcl interpreter can load packages to add features (written in C or Tcl, akin to Python modules), and then thereafter use "packages" when referring to Tcl add-ons? The alternative I think would be saying "Tcl module" everywhere vs. just "module" for Python.

@native-api native-api Jun 2, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use Tcl's official terminology to describe their relationship -- that way, the text will have an exact meaning.
No need to go into details: the reader only needs to know that: 1)it's some kind of loadable add-on; 2)it's implemented in C (which would explain how it can do GUI when Tcl itself can't); 3) it plugs itself into Tcl's machinery by adding custom Tcl commands.

@native-api native-api Jun 3, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

roseman#6

Expand Down