Skip to content

gh-126008: Improve docstrings for Tkinter cget and configure methods#133303

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

Jump to bottom
Merged
serhiy-storchaka merged 5 commits into from
Aug 12, 2025
Merged

gh-126008: Improve docstrings for Tkinter cget and configure methods #133303

serhiy-storchaka merged 5 commits into from
Aug 12, 2025

Conversation

@serhiy-storchaka
Copy link
Member

@serhiy-storchakaserhiy-storchaka commented May 2, 2025•
edited by bedevere-app bot
Loading

  • Explain the behavior of Widget.configure() depending on arguments.
  • Unify descriptions.
  • Replace "resource" with "option".

@serhiy-storchaka
pythongh-126008: Improve docstrings for Tkinter cget and configure me…
c7f9234
…thods * Explain the behavior of Widget.configure() depending on arguments. * Unify descriptions. * Replace "resource" with "option".
@serhiy-storchakaserhiy-storchaka added docs Documentation in the Doc dir skip news needs backport to 3.13 bugs and security fixes labels May 2, 2025
@bedevere-appbedevere-appbot mentioned this pull request May 2, 2025
Closed
tomasr8
tomasr8 reviewed May 2, 2025
View reviewed changes
terryjreedy
terryjreedy previously requested changes May 3, 2025
View reviewed changes
@bedevere-app
Copy link

bedevere-appbot commented May 3, 2025

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

@serhiy-storchakaserhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
@serhiy-storchakaserhiy-storchaka requested a review from a teamMay 13, 2025 10:36
bskinn
bskinn reviewed Jun 2, 2025
View reviewed changes
serhiy-storchaka
serhiy-storchaka commented Aug 11, 2025
View reviewed changes
@terryjreedyterryjreedy dismissed their stale reviewAugust 11, 2025 21:21

We agree that it would be better to have a separate issue/PR to handle option name formatting in docstrings in this entire file.

@serhiy-storchakaserhiy-storchaka merged commit 027cacb into python:mainAug 12, 2025
43 of 44 checks passed
@github-project-automationgithub-project-automationbot moved this from Todo to Done in Docs PRsAug 12, 2025
@miss-islington-app
Copy link

miss-islington-appbot commented Aug 12, 2025

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

@serhiy-storchakaserhiy-storchaka deleted the docs-tkinter-configure branch August 12, 2025 04:55
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 12, 2025
@serhiy-storchaka@miss-islington
pythongh-126008: Improve docstrings for Tkinter cget and configure me…
12f491a
…thods (pythonGH-133303) * Explain the behavior of Widget.configure() depending on arguments. * Unify descriptions. * Replace "resource" with "option". (cherry picked from commit 027cacb) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 12, 2025
@serhiy-storchaka@miss-islington
pythongh-126008: Improve docstrings for Tkinter cget and configure me…
b2568e8
…thods (pythonGH-133303) * Explain the behavior of Widget.configure() depending on arguments. * Unify descriptions. * Replace "resource" with "option". (cherry picked from commit 027cacb) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app
Copy link

bedevere-appbot commented Aug 12, 2025

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

@bedevere-appbedevere-appbot removed the needs backport to 3.14 bugs and security fixes label Aug 12, 2025
@bedevere-app
Copy link

bedevere-appbot commented Aug 12, 2025

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

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label Aug 12, 2025
serhiy-storchaka added a commit that referenced this pull request Aug 12, 2025
@miss-islington@serhiy-storchaka
[3.13]gh-126008: Improve docstrings for Tkinter cget and configure m…
4a630d7
…ethods (GH-133303) (GH-137661) * Explain the behavior of Widget.configure() depending on arguments. * Unify descriptions. * Replace "resource" with "option". (cherry picked from commit 027cacb) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@serhiy-storchaka
Copy link
MemberAuthor

serhiy-storchaka commented Aug 12, 2025

Thank you for your review, @terryjreedy, @bskinn.

maurycy added a commit to maurycy/cpython that referenced this pull request Aug 12, 2025
@maurycy
Merge branch 'main' into csv-sniffer-counter-set
11c891d
* main: pythongh-137288: Update 3.14 magic numbers (pythonGH-137665) pythongh-135228: When @DataClass(slots=True) replaces a dataclass, make the original class collectible (take 2) (pythonGH-137047) pythongh-126008: Improve docstrings for Tkinter cget and configure methods (pythonGH-133303) pythongh-131885: Use positional-only markers for ``max()`` and ``min()`` (python#131868) pythonGH-137426: Remove code deprecation of `importlib.abc.ResourceLoader` (pythonGH-137567) pythongh-125897: Mark range function parameters as positional only (python#125945) pythongh-137400: Fix a crash when disabling profiling across all threads (pythongh-137471) pythongh-115766: Fix IPv4Interface.is_unspecified (pythonGH-137326) pythongh-128813: cleanup C-API docs for PyComplexObject (pythonGH-137579) pythongh-135953: Profile a module or script with sampling profiler (python#136777) Fix documentation of hash in PyHash_FuncDef (python#137595)
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@serhiy-storchaka@Agent-Hellboy
pythongh-126008: Improve docstrings for Tkinter cget and configure me…
d7253bd
…thods (pythonGH-133303) * Explain the behavior of Widget.configure() depending on arguments. * Unify descriptions. * Replace "resource" with "option".
encukou pushed a commit that referenced this pull request Oct 7, 2025
@miss-islington@serhiy-storchaka
[3.14]gh-126008: Improve docstrings for Tkinter cget and configure m…
181cecc
…ethods (GH-133303) (GH-137660) * Explain the behavior of Widget.configure() depending on arguments. * Unify descriptions. * Replace "resource" with "option". (cherry picked from commit 027cacb) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tomasr8tomasr8tomasr8 left review comments

@AA-TurnerAA-TurnerAA-Turner left review comments

@terryjreedyterryjreedyterryjreedy left review comments

+1 more reviewer

@bskinnbskinnbskinn left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@serhiy-storchaka@tomasr8@AA-Turner@bskinn@terryjreedy