Skip to content

Commit 05c7a70

Browse files
miss-islingtonserhiy-storchakaclaude
authored
[3.15] gh-152587: Stop documenting bogus default values in tkinter variable methods (GH-152594) (GH-152596)
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 f4c2316 commit 05c7a70

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
@@ -1056,11 +1056,11 @@ Base and mixin classes
10561056
:class:`int`.
10571057
Raise :exc:`ValueError` if *s* is not a valid integer.
10581058

1059-
.. method:: getvar(name='PY_VAR')
1059+
.. method:: getvar(name)
10601060

10611061
Return the value of the Tcl global variable named *name*.
10621062

1063-
.. method:: setvar(name='PY_VAR', value='1')
1063+
.. method:: setvar(name, value)
10641064

10651065
Set the Tcl global variable named *name* to *value*.
10661066

@@ -1523,10 +1523,10 @@ Base and mixin classes
15231523
This updates the display of windows, for example after geometry changes,
15241524
but does not process events caused by the user.
15251525

1526-
.. method:: waitvar(name='PY_VAR')
1526+
.. method:: waitvar(name)
15271527
:no-typesetting:
15281528

1529-
.. method:: wait_variable(name='PY_VAR')
1529+
.. method:: wait_variable(name)
15301530

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

0 commit comments

Comments
 (0)