Skip to content

Commit 6f6256f

Browse files
miss-islingtonserhiy-storchakaclaude
authored
[3.14] gh-152587: Stop documenting bogus default values in tkinter variable methods (GH-152594) (GH-152597)
The name parameter of Misc.wait_variable(), setvar() and getvar() and the value parameter of setvar() should not be optional. Their default values ('PY_VAR' and '1') are not meaningful and should not be advertised. (cherry picked from commit e134a1a) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 352aada commit 6f6256f

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

Doc/library/tkinter.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1058,11 +1058,11 @@ Base and mixin classes
10581058
:class:`int`.
10591059
Raise :exc:`ValueError` if *s* is not a valid integer.
10601060

1061-
.. method:: getvar(name='PY_VAR')
1061+
.. method:: getvar(name)
10621062

10631063
Return the value of the Tcl global variable named *name*.
10641064

1065-
.. method:: setvar(name='PY_VAR', value='1')
1065+
.. method:: setvar(name, value)
10661066

10671067
Set the Tcl global variable named *name* to *value*.
10681068

@@ -1494,10 +1494,10 @@ Base and mixin classes
14941494
This updates the display of windows, for example after geometry changes,
14951495
but does not process events caused by the user.
14961496

1497-
.. method:: waitvar(name='PY_VAR')
1497+
.. method:: waitvar(name)
14981498
:no-typesetting:
14991499

1500-
.. method:: wait_variable(name='PY_VAR')
1500+
.. method:: wait_variable(name)
15011501

15021502
Wait until the Tcl variable *name* is modified, continuing to process
15031503
events in the meantime so that the application stays responsive.

0 commit comments

Comments
 (0)