FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-152587: Stop documenting bogus default values in tkinter variable methods by serhiy-storchaka · Pull Request #152594 · python/cpython · GitHub

Repository navigation

gh-152587: Stop documenting bogus default values in tkinter variable methods - #152594

Merged
serhiy-storchaka merged 1 commit into
python:mainfrom
serhiy-storchaka:tkinter-undoc-pyvar-defaults
Jun 29, 2026
Merged

serhiy-storchaka merged 1 commit into
python:mainfrom
serhiy-storchaka:tkinter-undoc-pyvar-defaults

Conversation

Copy link
Copy Markdown
Member

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, so stop documenting them.

This is the documentation-only part of the change (backportable).
A follow-up makes the parameters required in code on the main branch only.

…iable methods

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.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33356210 | 📁 Comparing e768f0d against main (b19839b)

  🔍 Preview build  

1 file changed
± library/tkinter.html

serhiy-storchaka merged commit e134a1a into python:main Jun 29, 2026
42 checks passed

Copy link
Copy Markdown

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

serhiy-storchaka deleted the tkinter-undoc-pyvar-defaults branch June 29, 2026 13:48
github-project-automation Bot moved this from Todo to Done in Docs PRs Jun 29, 2026

bedevere-app Bot commented Jun 29, 2026

Copy link
Copy Markdown

GH-152596 is a backport of this pull request to the 3.15 branch.

bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Jun 29, 2026

bedevere-app Bot commented Jun 29, 2026

Copy link
Copy Markdown

GH-152597 is a backport of this pull request to the 3.14 branch.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jun 29, 2026

bedevere-app Bot commented Jun 29, 2026

Copy link
Copy Markdown

GH-152598 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jun 29, 2026
serhiy-storchaka added a commit that referenced this pull request Jun 29, 2026
…riable 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>
serhiy-storchaka added a commit that referenced this pull request Jun 29, 2026
…riable methods (GH-152594) (GH-152598)

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>
serhiy-storchaka added a commit that referenced this pull request Jun 29, 2026
…riable 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant


Back | FazBrowse Home | New Git URL